Documentation 硬件项目的文档工具 出身背景

有一个硬件项目正在进行中。一组学生正在开发硬件加速器，但没有通用文档。
这里和那里有

README

s，一些

docx

s和in-code（

Verilog

，

C

和

Lua

）注释，但没有其他注释。代码是用

Vim

编写的，版本是

Git

，

Markdown

是我们的朋友，即使我们还没有上

Github

。
由于这个“东西”在增长，我觉得有必要写一些东西（用户手册？开发者笔记？），但我不知道从哪里开始

问题 当有人想记录他的项目时，从哪里开始 更具体地说，人们普遍接受的标准是什么，最好的工具是什么

我假设的答案 很明显，我们需要开发人员和用户手册。一个有算法解决方案的细节，另一个。。。喜欢猴子。

---

关于工具，我相信类似于

Github的Wiki

会很好地工作，但是（1）我们不是在

Github

上，并且（2）最终不会是

LaTeX

一种更好的写作方式来宣传它。我知道，我们可以使用以可打印方式呈现的

降价

，但这是最有效的解决方案吗

LaTeX

会对协作编辑和在线

HTML

发布造成麻烦。

可以找到部分答案。
答案的第二部分可以找到