[请教] 后台开发文档应该怎么写？

V2EX = way to explore

V2EX 是一个关于分享和探索的地方

现在注册

已注册用户请登录

这是一个创建于 1538 天前的主题，其中的信息可能已经有所发展或是发生改变。

作为后台的小兄弟们，你们最想看到什么样的开发文档呢？
有没有标准模板或大厂模板推荐学习一下？
谢谢！

第 1 条附言 · 2020-08-27 18:43:03 +08:00

我司后台开发是看产品经理画的原型文档，接口数据库自己随便设计。感觉很不合理，不太了解其它公司的后台开发看什么样文档呢？

模板

文档

后台

小兄弟

11 条回复 • 2020-08-28 09:57:25 +08:00

xomix

2020-08-27 17:15:27 +08:00

？？？
https://wenku.baidu.com/view/76c1b00d03768e9951e79b89680203d8cf2f6a1a.html
这种？？

ChevalierLxc

2020-08-27 17:15:38 +08:00

为什么做，如何做，为什么要这么做，可分为几个阶段做,有什么影响。写完就差不多了

raaaaaar

2020-08-27 17:18:49 +08:00 via Android

什么意思，给后台看的，还是后台写的

pushback

2020-08-27 17:27:27 +08:00

接口文档还是开发文档?

taogen

2020-08-27 17:47:22 +08:00 via Android

Software Design Document ？？

1. Introduction
1.1 Purpose
1.2 Scope
1.3 Audience
1.4 Document Organization
1.5 Acronyms, Abbreviations, Terms and Definitions
1.6 References

2. Design Considerations
2.1 Design Assumptions, Dependencies and Constraints
2.1.1 Assumptions and Dependencies
2.1.2 Design Constraints
2.2 Design Goals and Guidelines
2.2.1 Reliability
2.2.2 Usability
2.2.3 Portability
2.2.4 Extensibility

3. Architecture Design
System Architecture
Hardware Architecture
Software Architecture
Information Architecture
Internal Communications Architecture
Security Architecture
Performance

4. System Design
System User Cases
System Modules
Database Design
System Interface Design
User Interface Design

5. Detailed Design
xxx Module