V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
V2EX 提问指南
Dullsir
V2EX  ›  问与答

大佬们,你们的新项目开发文档一般都几天完成

  •  
  •   Dullsir · 2018-03-12 10:31:51 +08:00 · 1491 次点击
    这是一个创建于 2456 天前的主题,其中的信息可能已经有所发展或是发生改变。

    我这写了一个礼拜,没写几页,实在是无从下手

    5 条回复    2018-03-12 11:02:10 +08:00
    Moorj
        1
    Moorj  
       2018-03-12 10:40:03 +08:00
    萌新路过,开发文档的问题我问过,但是各公司的开发文档标准好像不太一样

    我个人是脑整理业务流程(业务非常熟悉)

    写数据库结构

    写 UI 界面结构

    然后直接就开始撸了
    Dullsir
        2
    Dullsir  
    OP
       2018-03-12 10:45:53 +08:00
    @Moorj #1 我这写了一个礼拜了,才写到功能模块之类的,离数据库结构,UI 之类的相距甚远啊

    以前不写文章直接开始撸,结果后期很多,这次想把标准确立起来再开发,结果跟写作文差不多了。
    niubee1
        3
    niubee1  
       2018-03-12 10:51:05 +08:00
    我的项目都是可以从代码一步生成 1. API 接口文档 ( 带在线测试 ) 2. 数据库结构文档 3. 页面结构 4. 模块调用逻辑
    前提是要写好 doc string.
    代码和文档高度同步, 省下了一大堆麻烦的事情
    ResidualSoils
        4
    ResidualSoils  
       2018-03-12 10:59:46 +08:00
    @niubee1 使用的什么工具可以推荐一下吗?
    niubee1
        5
    niubee1  
       2018-03-12 11:02:10 +08:00
    @ResidualSoils 自己写框架嘛, Python 还有啥不能搞定的
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   2565 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 21ms · UTC 05:12 · PVG 13:12 · LAX 21:12 · JFK 00:12
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.