大家在开发的过程，写技术文档的请进

lbqlbq 2004-09-06 03:44:55

大家是不是都碰到过，读别人的程序，在别人的程序基础上开发，在没有一点技术文档的前提下，大家的心情怎么样，是不是好累啊，是不是有点想推翻重作的想法，但是这是不可能的，我现在就想写一个这方面的技术文档，好让以后接手的人尽量不遇到我们的尴尬，谁有这方面的规范，能不能共享，借鉴一下，需要的是基于WEB开发，数据库开发，当然如果有其他方面的规范也可以，先谢了，可以发到我的邮箱：lbq@vip.0451.com,可以再送分……

...全文

222 点赞收藏 9

写回复

9 条回复

切换为时间正序

当前发帖距今超过3年，不再开放新的回复

发表回复

simonllf 2004-09-15

MARK

回复赞

gjd111686 2004-09-15

文档最好边做边写.就同工作笔记一个样.格式我个人认为无所谓.
http://blog.csdn.net/gjd111686/category/22110.aspx

回复赞

火电 2004-09-15

给你发了一份
别望了给分啊

回复赞

warton 2004-09-07

推荐再个网站：
51cmm
sawin.com.cn

回复赞

netcoder 2004-09-07

网上有有很多，并且是大公司的技术文档模本，去搜索一下吧

回复赞

lbqlbq 2004-09-07

有没有成型的技术文档，或者备忘录，不是全部，有格式也可以，发过来，我学习学习好吗

回复赞

blue 2004-09-07

代码的可读性，最好还是在代码中写入足够的注解，如果这样，整个系统而言，只需维护一份较功能设计详细，又没有详细设计那个清晰的文档就可以了，这样也省去了很多一边反馈修改一边维护详细设计文档带来的开销，等整个系统完成得差不多了，再一次或两三次将详细设计文档补充完整，进行归档保存。

回复赞

fly_higher 2004-09-07

嗯~~~
我觉得，只有大家都用同一种语言才能相互沟通。技术性文档，代码也一样。所以只要每个程序员在设计或编写的时候，遵循了大家认同的一种规范。这样，今后类似这样的问题也会少出现了！
不知道大家有没有听过这样一个中医理论：
假若门前有一堆死水，上面有很多的蚊子。用中医的理论，会用锄子挖一条沟，把这堆死水引走，这样蚊子也就自然不会来了。
我觉得这个理论很有建议意义！大家也可以仔细体会一下！

回复赞

elephant78 2004-09-06

我想这种情况你有这样的想法也是很正常，很多人也有同样的想法，但是补文档是最没有意义的事。
其实最关键的问题是他程序的可读性差，你可以看看他是不是有符合你们的代码规范（你们有没有代码规范），你们有没有定期的代码审查？在大部分时候，代码是最好设计文档，但在大部分时候，代码会很丑陋。还有就是配置管理说明，你是不是有时候也会查一个问题是找到代码需要很长的时间？

还有关于技术文档，我想你说的是详细设计，很多时候设计会导致后期工作量的加大，以及
像你这种web开发，后期需求的变化会导致你不仅要改代码你的设计文档维护工作，如果一有松懈，你的文档就会脱节，导致变成一堆废纸。对于详细设计要做到刚刚好，一些关键的模块才需要，要考虑到文档的代价。

也许你的前人也有过你现在的问题，合理的方法才会让你做的更好。
希望我的建议对你有帮助.

回复赞