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

野路子独立开发者,求一个标准的项目开发文档,大纲,什么都行,求参考

  •  
  •   Moorj · 2018-01-03 15:38:52 +08:00 · 2175 次点击
    这是一个创建于 2276 天前的主题,其中的信息可能已经有所发展或是发生改变。

    野路子出身,各种语言都会那么一点,平时做东西就是查文档,东拼西凑,也能跑起来,过得去

    之前从没写过开发文档,导致写大一点的项目(自用),就会写着写着忘了前面怎么写的了

    加上重度强迫症,总要回顾过去的代码,才能安心继续往下写

    太影响进度了,求各位公司就业的大佬,赏一个标准的项目开发文档 /大纲,什么都行,我想参考一下,非常感谢

    8 条回复    2018-01-03 16:48:49 +08:00
    blacklee
        1
    blacklee  
       2018-01-03 16:06:49 +08:00   ❤️ 1
    我也是独立开发者,推荐最近看的一本很薄的书,总字数不到 10W:《编写可读代码的艺术》

    对于你的问题「写着写着就忘了前面怎么写的了」的解决办法是写注释,其中有两章专门讨论的这个。
    Moorj
        2
    Moorj  
    OP
       2018-01-03 16:11:15 +08:00
    @blacklee 现在已经在写注释了,但是有时候可能脚本就上百个,所以想要个更牛逼的文档,这样直接看一遍,思路就建立好了
    huyue9106
        3
    huyue9106  
       2018-01-03 16:22:58 +08:00 via iPhone   ❤️ 1
    个人认为,设计合理的话,代码本身就可以是文档。
    最近在看的《重构,改善既有代码的设计》也不错
    cabing
        4
    cabing  
       2018-01-03 16:25:49 +08:00   ❤️ 1
    是不是找一本敏捷开发的书看看?

    我有段时间也挺迷茫的~~

    现在做公司或者个人的项目都做个简单的说明


    1 项目目标


    2 项目设计


    3 数据结构

    4 功能细化
    luohc2004
        5
    luohc2004  
       2018-01-03 16:28:00 +08:00 via Android   ❤️ 1
    代码大全 这本书里有讲。有人写程序像写信,抬笔边想边写,程序大了就写不好了。有人写信像建房子,先设计图纸,再完成构件,最后组装。也有介于其中的模式。推荐 重构,把一些通过部分改成构件,防止代码烂掉
    Moorj
        6
    Moorj  
    OP
       2018-01-03 16:29:42 +08:00
    @luohc2004 谢谢,我去看下,非常感谢
    qsnow6
        7
    qsnow6  
       2018-01-03 16:31:16 +08:00
    还是得要注释,最低成本的方法。

    把代码写成诗。。能行的话你也不会上来求助了
    blacklee
        8
    blacklee  
       2018-01-03 16:48:49 +08:00
    如果是上百个脚本这种问题,那就属于「命名」相关的了。

    计算机科学只存在两个难题:缓存失效和命名。
    ——————真正的大佬这样说

    如果说你没有洁癖的话,可以考虑中文命名。否则,除了增加内功,好像并没有太多的方法。
    我想你并不能做到维护一个文档,然后在脚本增加、删除时更改文档,特别是在修改了脚本内容之后发现这个脚本做的事变了,那是不是该重命名一下脚本文件名?
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   我们的愿景   ·   实用小工具   ·   1488 人在线   最高记录 6543   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 24ms · UTC 17:19 · PVG 01:19 · LAX 10:19 · JFK 13:19
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.