什么是documentation?

AdventChildren

原帖由 快乐每一天 于 14-6-2007 01:23 PM 发表
documentation可以学到东西吗?我很多朋友听到实习时做documentation的东西都在摇头说别去呢!

可能他所指的documentation是纯负责图文整理，没涉及系统开发的。
建议去公司问清楚工作范围咯～

goatstudio

很多刚毕业的新手，都急着要在这一行里大展身手。。。这样想其实没有错，只是还得按部就班。学校里学的，毕竟不是白白学习，也不只是学习那些编程语言。

你去实习，公司给你几个任务让你去编程个够，用 Java 啦 C# 啦是没错你可以学习到实际的工作经验，但是公司可能只是把你当成廉价劳工。一个真正有心栽培你的公司，会先从做好文件开始，让你参与设计开发，即使你只是在一旁看，都已经够你学。。。

你以为 documentation 是什么？写帮助文件？从 Functional Spec, Technical Spec, UML Diagram, Database Design。。。一直到 UAT 文件，全部都是 documentation。

学习这些，是不是比单单学习任何一种语言来得有挑战性？因为这样的一个技术，其实是可以运用在任何一种任务，任何一种编程语言上。

vampcheah

documentation 很重要的呢。。。 写不好的话，以后的人很难接手。试想想5-6 年前你写的PROGRAM  LOGIC 你还记得吗？没有documentation 的话就得重头再看过。。。

那间某某公司在面试时要求我做的是documentation like user help manual..还有少少VB scripting.. 他/她在面试时给我的考试是写英文作文呢!还有问些在学校做过什么project而已,并没有考technical的东西. 感觉上怪怪的.

俊俊杰杰

但是公司会给我参与Functional Spec, Technical Spec, UML Diagram, Database Design,UAT 等的重要文件吗????我可是trainee而已喔.

[ 本帖最后由 俊俊杰杰 于 15-6-2007 07:11 PM 编辑 ]

elvinlee

不好意思, 我有一个愚问.
请问, documentation = 程序的流程?

wuichia

楼主不用担心的。
documentation是门大学问，属于soft skill。
这份差事肯定能学到不少东西，有前途的。
公司会不会把那些Functional Spec, Technical Spec, UML Diagram, Database Design,UAT 等交给你做呢，就得看得你的造化及心态了
当然也要看公司对你的能力信心到哪里。
你可从做各种documents里学到别人（前辈/高手们）解决问题的方案，如能从中看到他们方案的缺点或是有所领悟，那就是你学到“你那些看不起documentation差事的同学们“所学不到或是要花几年时间类出的经验的东西了。

对了，我不是编程员，我是ERP Specialist。

goatstudio

原帖由 俊俊杰杰 于 15-6-2007 07:05 PM 发表
但是公司会给我参与Functional Spec, Technical Spec, UML Diagram, Database Design,UAT 等的重要文件吗????我可是trainee而已喔.

当然不太可能，但你可以从旁学习。这些文件可以用在任何一种编程语言上。

max5007

详细DOCUMENTATION还会写下每个版本所遇到的问题，解决方法，时间等。。这有点类似武功秘籍了。。可惜大部分本地的软件公司都没有这样详细的

俊俊杰杰

谢谢大家的支持,想不到我第一次做楼主,就得到这样多的回应,以后要多多指教啊!!!

elvinlee

原帖由 elvinlee 于 16-6-2007 02:24 AM 发表
不好意思, 我有一个愚问.
请问, documentation = 程序的流程?

请问, 是这样吗?

wuichia

原帖由 elvinlee 于 26-6-2007 03:01 PM 发表


请问, 是这样吗?

不是这样说。
流程is subset of Documentation.
也是说流程只是其中的一种documentation

max5007

原帖由 SotongJiang 于 27-6-2007 02:50 AM 发表
想象一下，辛辛苦苦(投入许多人力，物力，财力和时间)建立的复杂系统却没有详细的documentation在背后支撑，日后旧人走掉，要重新学会使用和maintain该系统就很难了。

是我的话，就不敢想了,想了就发恶梦