记录程序架构 [英] Documenting program architecture

问题描述

什么发现人要记录一个大项目的架构使程序员新的code能得到他们的轴承的有效方法（相对）迅速？

What have people found to be effective methods of documenting the architecture of a large project so that programmers new to the code can "get their bearings" (relatively) quickly?

推荐答案

我放弃了昂贵的专有工具（即Visio中）。我只是没有看到投资回报（而不是工具的成本，开销和时间消耗）。

I gave up on proprietary expensive tools (i.e. visio). I just don't see the return on investment (not the cost of the tool, the overhead and time consumed).

什么失败几乎总是是文档是过时的编码的第一天的流逝之前。我的解决办法：强推维基

What fails almost always is that the documentation is obsolete before the first day of coding goes by. My solution: Strong Wiki push.

每个人负责，能随时更新维基，图像可以与任何他们想要的软件，只要在年底有一个在维基网页内嵌的图像进行。这对我的伟大工程。我文献数据库这种方式为好，存储过程，常见问题解答，错误，报告......

Everyone are responsible and able to update the wiki at any time, images can be made with whatever software they want, as long as at the end there is an image embeded in the wiki page. This works great for me. I document Database this way as well, Store procedures, FAQ, errors, reports....

这篇关于记录程序架构的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！