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

2020-08-27 16:42:26 +08:00
 niselover
作为后台的小兄弟们,你们最想看到什么样的开发文档呢?
有没有标准模板或大厂模板推荐学习一下?
谢谢!
2551 次点击
所在节点    程序员
11 条回复
xomix
2020-08-27 17:15:27 +08:00
ChevalierLxc
2020-08-27 17:15:38 +08:00
为什么做,如何做,为什么要这么做,可分为几个阶段做,有什么影响。 写完就差不多了
raaaaaar
2020-08-27 17:18:49 +08:00
什么意思,给后台看的,还是后台写的
pushback
2020-08-27 17:27:27 +08:00
接口文档还是开发文档?
taogen
2020-08-27 17:47:22 +08:00
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
ifsclimbing
2020-08-27 17:48:17 +08:00
openapi, swagger?
tomy0608
2020-08-27 18:25:16 +08:00
@ifsclimbing + 1. 开发有这个基本就够了.
niselover
2020-08-27 18:44:51 +08:00
@ChevalierLxc #2
@raaaaaar #3
@pushback #4

请教一下,后台需求开发的流程是什么?
后台需要什么文档来设计接口,设计数据库呢?
bintianbaihua
2020-08-27 21:12:02 +08:00
@taogen 可以
oneisall8955
2020-08-27 22:17:12 +08:00
swagger
pushback
2020-08-28 09:57:25 +08:00
swagger 是作为后台接口 API 的框架,一般来说有这个就行了,可适当在注解上进行扩展,
开发流程工作上按原型图和模块来吧,私人随意,一般是主要业务先行于次要业务。
数据库设计就用 powerdesigner,我目前是比较习惯的,中大型的设计可以用这个。

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/701950

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX