iteye_7903 2009-09-04 11:54
浏览 279
已采纳

代码维护，应该产生什么样的文档呢？

目前，公司刚为我分配了工作任务。就是维护代码，熟悉整个工程的体系结构，掌握各个细节逻辑。

现在问题的关键是，这个项目没有文档，代码没有注释。我准备一边熟悉工程代码，一边自己书写工程文档，还可以锻炼我的文档编写能力。

我却不知道该构造出什么样的项目文档，才能达到清晰描述整个工程体系结构的目的。

还望大家指点！不胜感激！

附：给我推荐个有关项目文档的网站，我自己去学学……

或则，给我点项目文档的模板，我参考参考……

或则，用您的方式或建议，指点我……

谢谢！！！

  • 写回答

3条回答 默认 最新

  • hunterli0408 2009-09-04 21:04
    关注

    项目的架构文档加项目所涉及业务的详细设计书，有这两个的话，应该就足以维护代码了。

    本回答被题主选为最佳回答 , 对您是否有帮助呢?
    评论
查看更多回答(2条)

报告相同问题？

悬赏问题

  • ¥50 关于#html5#的问题：H5页面用户手机返回的时候跳转到指定页面例如(语言-javascript)
  • ¥15 无法使用此凭据登录，因为你的域不可用，如何解决？(标签-Windows)
  • ¥15 yolov9的训练时间
  • ¥15 二叉树遍历没有报错但无法正常运行
  • ¥15 在linux系统下vscode运行robocup3d上场球员报错
  • ¥15 Python语言实验
  • ¥15 SAP HANA SQL 增加合计行
  • ¥20 用C#语言解决一个英文打字练习器，有偿
  • ¥15 srs-sip外部服务 webrtc支持H265格式
  • ¥15 在使用abaqus软件中，继承到assembly里的surfaces怎么使用python批量调动