基于PHP的手动应用程序

Question

是否有用于编写tehcnical / API类型手册的精心制作的Web应用程序？我有一些代码，我想写一些“入门”指南，也许还有一些参考内容。

PHPDocumentor很好用于记录我的类heirarchy，但我也想把一些更人性化和线性的东西放在一起。我想一般的CMS可以正常工作，或者只是从头开始构建一些东西。但如果有任何专门为编写在线手册而设计的东西，我很想知道更多。

Answer 1

DocBook将是编写手册的方法之一，但我不知道任何CMS。我已经分享了它在PEAR上的工作，到目前为止，我总是使用常规文本编辑器来编写/编辑页面。我想，从头开始是更难。

如果您需要更多直观的内容，请尝试dokuwiki。它非常小巧轻便，而且很有效。

另外，请记住，phpdoc允许您嵌入代码示例等，因此也可以查看那个（例如：inline {@example}）。

Answer 2

大多数人将他们的文档写在类似wiki的服务中。 Google代码有一个，或者您可以安装自己的代码，例如MediaWiki或Trac。

Answer 3

我不知道它是否能为您完成这项工作，但是通过www.php.net在线提供的整个PHP手册是一个开源应用程序。

不知道它的内部结构，但从用户POV看起来还不错。

Answer 4

我刚才发现这些链接......

http://www.winnershtriangle.com/w/Products.PHPDocumentationTool.asp

http://doc.php.net/php/dochowto/

...享受

Answer 5

restructured text是Python社区的热门选择。