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

代码维护,应该产生什么样的文档呢?

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

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

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

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

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

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

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

谢谢!!!

  • 写回答

3条回答 默认 最新

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

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

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

报告相同问题?

悬赏问题

  • ¥15 乘性高斯噪声在深度学习网络中的应用
  • ¥15 运筹学排序问题中的在线排序
  • ¥15 关于docker部署flink集成hadoop的yarn,请教个问题 flink启动yarn-session.sh连不上hadoop,这个整了好几天一直不行,求帮忙看一下怎么解决
  • ¥30 求一段fortran代码用IVF编译运行的结果
  • ¥15 深度学习根据CNN网络模型,搭建BP模型并训练MNIST数据集
  • ¥15 C++ 头文件/宏冲突问题解决
  • ¥15 用comsol模拟大气湍流通过底部加热(温度不同)的腔体
  • ¥50 安卓adb backup备份子用户应用数据失败
  • ¥20 有人能用聚类分析帮我分析一下文本内容嘛
  • ¥30 python代码,帮调试,帮帮忙吧