软件文档应包含什么内容.我应包含什么内容?您可以指定吗? [英] what should a software documents contains in it .what should i include.can u just specify

问题描述

我必须在文档中包含哪些信息.

what information i have to include in the documentation.

推荐答案

所有内容.

理想情况下，可以使用文档来帮助新手(或您自己在六个月内)加快软件开发速度.您可以提供的所有内容都应该会有所帮助.

在现实世界中，在项目结束时，不关心文件的人会在管理人员的巨大时间压力下不​​关心文件，而现在他们希望他们进行新项目.

就我个人而言，我更喜欢在可能的情况下尽量做到这一点.这样，我知道它至少与之相关.

Everything.

Ideally, documentation is there to help a new person (or yourself in six months time) come up to speed on the software as fast as possible. Everything that you can provide which will help that should be included.

In the real world, documentation is thrown together at the end of the project by people who don''t care about it under serious time pressure from management who want them on a new project NOW.

Personally, I prefer to do it as I go along, when I can. That way I know it is at least relevant.

这篇关于软件文档应包含什么内容.我应包含什么内容?您可以指定吗?的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！