J**********y
发帖数: 1891 | 1 如何建立比较好的文档系统？
我是组里的新人。组里没有完善的文档（基本没有）。结果一个人不在的话他所管的那
摊子就近乎瘫痪。领导说要听听我的看法和建议。这真是给我出难题啊。还请大家帮我
出出主意。看看我应该怎么回答领导的问题。既显得言之有物，又不让组里的老员工难
堪（估计领导是私下里听我的看法）。
谢谢指点啊！ |
m*****e
发帖数: 4193 | 2 Funcitonal/Design spec, test plan, etc etc
【在 J**********y 的大作中提到】
: 如何建立比较好的文档系统？
: 我是组里的新人。组里没有完善的文档（基本没有）。结果一个人不在的话他所管的那
: 摊子就近乎瘫痪。领导说要听听我的看法和建议。这真是给我出难题啊。还请大家帮我
: 出出主意。看看我应该怎么回答领导的问题。既显得言之有物，又不让组里的老员工难
: 堪（估计领导是私下里听我的看法）。
: 谢谢指点啊！
|
d**********0
发帖数: 13081 | 3
It is hard to do/maintain the func spec and test spec..
How to update func/test/code in a easy way to make them consistent?
【在 m*****e 的大作中提到】
: Funcitonal/Design spec, test plan, etc etc
|
F********g
发帖数: 475 | 4 You need a version control system.
【在 J**********y 的大作中提到】
: 如何建立比较好的文档系统？
: 我是组里的新人。组里没有完善的文档（基本没有）。结果一个人不在的话他所管的那
: 摊子就近乎瘫痪。领导说要听听我的看法和建议。这真是给我出难题啊。还请大家帮我
: 出出主意。看看我应该怎么回答领导的问题。既显得言之有物，又不让组里的老员工难
: 堪（估计领导是私下里听我的看法）。
: 谢谢指点啊！
|
J**********y
发帖数: 1891 | 5 目前的问题似乎还不在这里。
我们的问题是某人写的程序别的人不会用。
如果他不在，又任务紧急没有时间仔细研究他的程序的话，大家就只好歇菜--因为不会
用他的程序
【在 m*****e 的大作中提到】
: Funcitonal/Design spec, test plan, etc etc
|
J**********y
发帖数: 1891 | 6 wiki已经有了。上面的东西很不全，好久没有更新了。
We also have VCS...
还请多给我几个能够让老板至少觉得言之有理的建议吧。
非常感谢！ |
g***l
发帖数: 2753 | 7 1.high level design document,such as UML for class/struct design,including
description of your component's relationship with other components.
2.Interface design document,including detail description of your major APIs,
not only the interface APIs.
3.Unit test plan with unit test code, included in your component
src folder/test/
4. Doxygen description in header file
These 4 docs are required as MUST for my company.
【在 J**********y 的大作中提到】
: wiki已经有了。上面的东西很不全，好久没有更新了。
: We also have VCS...
: 还请多给我几个能够让老板至少觉得言之有理的建议吧。
: 非常感谢！
|
r********n
发帖数: 7441 | 8 最简单的就是 input /output protocol control
定义好 I/O 规范以后，内部怎么回事各人自己负责
【在 J**********y 的大作中提到】
: 目前的问题似乎还不在这里。
: 我们的问题是某人写的程序别的人不会用。
: 如果他不在，又任务紧急没有时间仔细研究他的程序的话，大家就只好歇菜--因为不会
: 用他的程序
|
J**********y
发帖数: 1891 | 9 我们是两层意思：
1.操作上不会用他的软件，没有使用说明；
2.如果出了bug, 看不懂他的程序，因为里面没有文档。 |
p***o
发帖数: 1252 | 10
这个是最基本的文档要求了吧。
这个基本上没戏，有文档也不一定看得懂，看得懂也不一定找得到bug，有找
bug的时间也许够从头开发一个了 ...
【在 J**********y 的大作中提到】
: 我们是两层意思：
: 1.操作上不会用他的软件，没有使用说明；
: 2.如果出了bug, 看不懂他的程序，因为里面没有文档。
|
|
|
L***n
发帖数: 6727 | 11 那先让丫弄个使用说明出来
【在 J**********y 的大作中提到】
: 我们是两层意思：
: 1.操作上不会用他的软件，没有使用说明；
: 2.如果出了bug, 看不懂他的程序，因为里面没有文档。
|
J**********y
发帖数: 1891 | 12 我就是要向领导提几点建议，那种能够让老板觉得我说的make sense的几条建议。。。
我肚里没货啊，自己没有参加过大型项目。。。
还请大家指点。
谢谢！
【在 L***n 的大作中提到】
: 那先让丫弄个使用说明出来
|
p*********t
发帖数: 2690 | 13 靠，你老板让你来改革？这不是让老人们难堪吗？这个老板真精明。
【在 J**********y 的大作中提到】
: 如何建立比较好的文档系统？
: 我是组里的新人。组里没有完善的文档（基本没有）。结果一个人不在的话他所管的那
: 摊子就近乎瘫痪。领导说要听听我的看法和建议。这真是给我出难题啊。还请大家帮我
: 出出主意。看看我应该怎么回答领导的问题。既显得言之有物，又不让组里的老员工难
: 堪（估计领导是私下里听我的看法）。
: 谢谢指点啊！
|
J**********y
发帖数: 1891 | 14 我可以在我这个新人学习的过程中做笔记，建立起文档，不需要花费老人们的时间。
现在只需要提几个make sense的points过关就行。。。
请指点
【在 p*********t 的大作中提到】
: 靠，你老板让你来改革？这不是让老人们难堪吗？这个老板真精明。
|
c*****m
发帖数: 1160 | 15 Read the book of "Code Complete".
Don't document. Write code that is easy to read.
I've never seen a document that is up-to-date. |
G***l
发帖数: 355 | 16 个人也觉得文档就是扯谈。
重要的是把系统做好，每个component的一看名字就知道是干什么的。每个class/
method都要清楚明白，unit test要写好，基本就不需要文档了。最多有个highlevel的
介绍system的文档，每个class，interface有个简略的说明。
【在 c*****m 的大作中提到】
: Read the book of "Code Complete".
: Don't document. Write code that is easy to read.
: I've never seen a document that is up-to-date.
|
l*******G
发帖数: 1191 | 17 Here is my suggestion:
1) Buy the latest version of Understand from SciTools company
2) Install Understand, and then open the source code in it, then you can
analyze code and generate call graphs etc.. Save the project as an udb file.
3) go to the install directory of understand in command line:
cd c:\program files\SciTools\bin\pc-win32\
use the und.exe program the following ways:
und.exe report "C:\path\to\the\udb\file.udb"
Which will automatically generate html pages for you for the whole source
code in the same directory of the udb file . It supports many programming
languages: C/C++ C# Fortran Java Pascal PL/M VHDL
Here is more on how it works:
http://www.scitools.com/support/videos.php
http://scitools.com/blog/2011/07/integrate-understand-with-your
http://scitools.com/blog/category/understand-2-6
【在 J**********y 的大作中提到】
: 如何建立比较好的文档系统？
: 我是组里的新人。组里没有完善的文档（基本没有）。结果一个人不在的话他所管的那
: 摊子就近乎瘫痪。领导说要听听我的看法和建议。这真是给我出难题啊。还请大家帮我
: 出出主意。看看我应该怎么回答领导的问题。既显得言之有物，又不让组里的老员工难
: 堪（估计领导是私下里听我的看法）。
: 谢谢指点啊！
|
