Documentation 摘要中的软件文档子块

Documentation 摘要中的软件文档子块,documentation,Documentation,我有一份摘要,其中包括以下内容(请随意更改格式): 1. purpose 2. simulation models used 3. libraries, SDKs, and APIs used 4. major components of application in terms of the windowing blocks, and types of user controls and settings offered in the application for si

我有一份摘要,其中包括以下内容(请随意更改格式):

1. purpose
2. simulation models used
3. libraries, SDKs, and APIs used
4. major components of application in terms of the    
   windowing blocks, and types of user controls and settings offered in 
   the application for simulation operation
5. methods of controlling the input coordinates for the simulation to execute 
   and generate an output

但是,现在我不知道我接下来应该在文档中处理哪些子块。作为一个不知道我的应用程序是做什么的人,您认为进一步详细描述什么更有用?提前感谢您的建议。

对于一个普通用户,请在应用程序中具体说明用途和设置阳离子

对于开发人员来说更加重视所使用的库、SDK和API

再看看这个问题


您至少有两个文档。软件用户关心1、2和5。开发人员对3感兴趣。不确定4是实现还是UI

我强烈建议首先准备用户指南。我可以用这个软件做什么,我如何驱动它?你甚至可能会发现你需要将详细参考从指南中分离出来


内部资料可以稍后再提供。

了解这些信息后,如果我为普通用户和开发人员编写,我是否应该分别为他们编写手册?最好是分别编写。感谢您的推荐。我想我会为这两个文档保留1,因为用户和开发人员都会对他们为什么使用或删除这些文档感兴趣软件之王。是的,这很有意义。我要说的基本点是,在读者阅读文档时,关注他们的需求。作为热衷于软件的人,当读者想知道“什么和为什么”时,我们很容易进入实现细节,即“如何”。