用什么工具来写文档？

问题描述

具体用于

• 用户文档


• 系统管理


• 开发

我正在寻找软件，如MS Word，wiki，TeX（LaTeX，LyX）和自动化工具。

解决方案

我写在Markdown中，我们在Stack Overflow上使用相同的格式化语法。因为这些文件是纯文本，它们可以与版本控制中的代码一起使用。这很有用。

我用瑞士军刀将文件呈现为HTML和PDF 。使用简短的样式表，这些看起来比文字处理器的文档更好。

---

如果我们在谈论技术文档，在我看来，有两种不同的文档，你应该有两个。对于库和API，有自动生成的文档描述了对参考有用的函数调用和类型，但是您还需要可以从上到下阅读的用户指南/教程样式文档：

• 黑客的Pandoc


• 用户（和黑客）的Pandoc

附录：您可以使用的两种文档。输出是美丽的

将让您开始使用Sphinx并为您托管网站

What tools are used to write documentation?

Specifically for

• User docs
• System administration
• Development

I'm looking for software such MS Word, wiki, TeX (LaTeX, LyX) and for automated tools.

解决方案

I write in Markdown, the same formatting syntax we use on Stack Overflow. Because the documents are plain text, they can live alongside code in version control. That's useful.

I render the documents to HTML and PDF with the swiss army knife Pandoc. With a short stylesheet, these look better than documents from word processors.

---

If we're talking about technical documentation, in my mind there are two separate kinds of documentation, of which you should have both. For libraries and APIs there is auto-generated documentation describing the function calls and types which is useful for reference, but you also need prosy user guide/tutorial style documentation that can be read top to bottom:

• Pandoc low level API reference for hackers
• Pandoc prosy user guide for users (and hackers)

Addendum: You can use Sphinx for both kinds of documentation. The output is beautiful

• http://scikit-learn.org/stable/user_guide.html
• http://scikit-learn.org/stable/modules/classes.html

https://readthedocs.org/ will get you started with Sphinx and host the site for you

这篇关于用什么工具来写文档？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持！