如何为Android项目编写技术文档？

Question

我已经创建了SRS文档，和小设计文档。现在，我正在努力创建技术文档，当我们为他们分配更新任务时，它必须作为新开发人员的参考。目录里有什么东西？

Answer 1

这个问题含糊不清，所以我试着回答两种解释。

我不知道从哪里开始写这份技术文件，但如果有人能告诉我TOC属于什么，我也许可以从中找出答案。你没有提供足够的细节让我们告诉你什么是属于你的TOC。以下是一些选择：

• 在你的项目中问别人
• 问你项目中的每一个人
• 找到一个描述类似Android项目的文档。
• 和一个以写作为生的人交谈。
• 问问自己，对于一个新开发人员来说，什么是重要的。

如果所有这些都没有帮助，也许你应该让其他人来写技术文档。当你不知道如何做某事时，寻求帮助通常是可以的。

我想我知道什么属于技术文件，但我不知道如何决定什么属于TOC。这听起来像一个纯粹的写作问题，与测试无关。找一个以写作为生的人，或者如果不起作用，就找一个经常读书的人。