V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
niselover
V2EX  ›  程序员

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

  •  
  •   niselover · 99 天前 · 1377 次点击
    这是一个创建于 99 天前的主题,其中的信息可能已经有所发展或是发生改变。
    作为后台的小兄弟们,你们最想看到什么样的开发文档呢?
    有没有标准模板或大厂模板推荐学习一下?
    谢谢!
    第 1 条附言  ·  99 天前
    我司后台开发是看产品经理画的原型文档,接口数据库自己随便设计。感觉很不合理,不太了解其它公司的后台开发看什么样文档呢?
    11 条回复    2020-08-28 09:57:25 +08:00
    ChevalierLxc
        2
    ChevalierLxc   99 天前
    为什么做,如何做,为什么要这么做,可分为几个阶段做,有什么影响。 写完就差不多了
    raaaaaar
        3
    raaaaaar   99 天前 via Android
    什么意思,给后台看的,还是后台写的
    pushback
        4
    pushback   99 天前
    接口文档还是开发文档?
    taogen
        5
    taogen   99 天前 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
    ifsclimbing
        6
    ifsclimbing   99 天前
    openapi, swagger?
    tomy0608
        7
    tomy0608   99 天前
    @ifsclimbing + 1. 开发有这个基本就够了.
    niselover
        8
    niselover   99 天前
    @ChevalierLxc #2
    @raaaaaar #3
    @pushback #4

    请教一下,后台需求开发的流程是什么?
    后台需要什么文档来设计接口,设计数据库呢?
    bintianbaihua
        9
    bintianbaihua   99 天前
    @taogen 可以
    oneisall8955
        10
    oneisall8955   99 天前 via Android
    swagger
    pushback
        11
    pushback   99 天前
    swagger 是作为后台接口 API 的框架,一般来说有这个就行了,可适当在注解上进行扩展,
    开发流程工作上按原型图和模块来吧,私人随意,一般是主要业务先行于次要业务。
    数据库设计就用 powerdesigner,我目前是比较习惯的,中大型的设计可以用这个。
    关于   ·   FAQ   ·   API   ·   我们的愿景   ·   广告投放   ·   感谢   ·   实用小工具   ·   2954 人在线   最高记录 5298   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 16ms · UTC 06:25 · PVG 14:25 · LAX 22:25 · JFK 01:25
    ♥ Do have faith in what you're doing.