摘要的软件文档子块 [英] Software Documentation sub-blocks from an abstract

问题描述

我有一个摘要，其中包含以下内容（请随意更改格式：

I have an abstract that includes the following (please feel free to change the formatting :

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

然而，现在我不知道下一步应该在文档中工作的子块，作为不知道我的应用程序的人，你是什么认为更有用的描述更详细？感谢提前建议。

However, now I'm unaware of which sub-blocks I should work on next in terms of the documentation. As someone who doesn't know what my application does, what do you think would be more useful to describe in further detail? Thanks in advance for suggestions.

推荐答案

你至少有两个文件软件的用户关心1，2和5.开发人员感兴趣3.不确定是否实现引用或UI。

You've got at least two documents there. Users of the software care about 1, 2 and 5. Developers are interested in 3. Not sure whether 4 is implementation or UI.

我强烈建议您先准备用户指南。我可以用这个软件做什么，我该怎么开车？您甚至可能会发现，您需要细细分类指南中的详细参考资料。

I would strongly recommend first preparing the User Guide. What can I do with this software, how do I drive it? You may even find that you need to subdivied that separating the detailed Reference from the Guide.

内部的内容可能会稍后再来。

The internal stuff can come later.

这篇关于摘要的软件文档子块的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！