Closed. This question is seeking recommendations for books, tools, software libraries, and more. It does not meet Stack Overflow guidelines. It is not currently accepting answers.
我们不准许对书籍、工具、软件图书馆以及更多的图书馆征求建议的问题。 你可以ed问这个问题,以便用事实和引言回答。
Closed 5 years ago.
目前,我工作的文件属于一个国家。 几乎没有任何地方,现有的文件散布在许多字面上,难以找到任何东西。
我试图采取一些举措,并改进这一举措。
- My thoughts are that the documentation should be structured in a series of short articles (MSDN / Html Help style) and structured in a suitable tree:
- It would be good to be able to produce a standalone Html-Help style package to be shipped with the application
- As well as being able to produce a MSDN-style website as a reference for those who are too lazy to look at the CD.
- Search is of course a must-have
- It needs to be at least reasonably easy to update - if there is a 17 step process to update the published documentation then it makes it seem like too much work to do simple changes, and nobody can ever be bothered to update it.
- The documentation is technical in nature, and so ideally it would be nice to be able to include generated documentation from things like the Xml documentation embedded in C# code. This is however definitely a side-requirement - currently very little useful Xml documentation exists, its just that in the future I plan to fix that.
- For the same reason it is often good to be able to handle things like attachments (code samples etc...) I m not expecting anything fancy, but this is something I need to bear in mind to make sure that its at least not handled badly.
是否有任何项目或语言适合这类文件?