硬件项目的文档工具

Question

背景

正在进行硬件项目。一个学生团队正在开发硬件加速器，但没有一般文件 这里和那里有README个，docx和 in-code （Verilog，C和Lua）评论， 但没有别的。代码使用Vim编写，版本为Git，Markdown是我们的朋友，即使我们尚未Github（尚未）。 由于这个“事物”正在增长，我觉得有必要写下一些东西（用户手册？开发者笔记？）但我不知道从哪里开始。

问题

当有人感到记录他的项目的冲动时，它从哪里开始？
更具体地说，普遍接受的标准是什么以及最佳工具是什么？

我的假设答案

我们非常需要开发人员和用户手册。一个是算法解决方案的细节，另一个是...像猴子一样 关于工具，我相信像Github Wiki这样的东西可以正常工作，但是（1）我们不在Github而且（2）不会是LaTeX更好的写作方式最终，为了宣传它。我知道我们可以使用http://www.cocowrite.com/以可打印的方式呈现Markdown，但它是最有效的解决方案吗？ LaTeX会对协作编辑和在线HTML发布产生麻烦。

Answer 1

可以找到部分答案here: “What tools are used to write documentation?” 答案的第二部分可以找到here: “What amount of documentation is needed for a non-trivial one-man software project”