本文讨论了在软件项目中完成文档结论的重要性，强调了集中化、维护性信息源的需求，以及开发者文档和构建文档对于理解、维护和演进代码的作用。详细介绍了需要记录的主题，包括代码内部、组织、开发环境、初始开发指南、软件架构概述、特性、过程（如代码审查、提交等）、当前实施状态、构建顺序、设置、模板、模块位置等关键信息。
Do you have finished the below document conclusion after one project?
This information maybe has been recorded in various interpersonal communications, such as e-mail and instant messages. Those communications are usually lost when individuals (e.g., designers, programmers, testers) stop working on a feature.
This we need entry identifies a centralized, current, and maintained source of information. This source may even be simply a centralized location the refers to other locations for the original information.
We need doveloper documentations to record the following topics.
- Code internals
- Code organization
- Development environment and tools
- Getting started as a new developer
- Overview of software architecture
- Overview of features
- Overview of processes (e.g., coding, reviews, submissions)
We need feature documentation that covers the current state of the implementation.
This documentation would include:
- Architectural diagrams and discussions
- Class diagrams and discussions
- Overview documentation
- Significant implementation decisions
This documentation should cover the information needed to assist new programmers assigned to a feature. This information is the gap between high-level documents (e.g., HLSD's and specifications) and the source code.
We need documentation for the build to help evolve, maintain, and understand it.
The documentation should answer or explain:
- What is the build order? The build order defines what modules are available for link dependencies.
- What build settings should I use?
- What templates are available for my new module?
- Where should I place my new module?
Please ask yourself, do you have such kinds of documents?
扫一扫
3万+
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
