Python论坛  - 讨论区

标题:[python-chinese] [谈谈设计]关于详细设计

2006年08月02日 星期三 19:53

Ai92 yuanyk at gmail.com
Wed Aug 2 19:53:48 HKT 2006

最近一直在思考关于详细设计的一些问题,总结如下文
http://blog.csdn.net/ai92/archive/2006/08/02/1011883.aspx

虽然这个和python无关,但是设计无语言障碍,详细列表中有许多经验丰富,技艺超群的高手。

希望能和广大同仁进一步的探讨。大家不妨借此帖交流交流

-- 
此致
                            敬礼
************************************************
苑永凯
个人邮件: yuanyk at gmail.com
个人网址: http://blog.csdn.net/ai92
************************************************
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.exoweb.net/pipermail/python-chinese/attachments/20060802/e9d1a2f9/attachment.htm

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2006年08月02日 星期三 20:05

yi huang yi.codeplayer at gmail.com
Wed Aug 2 20:05:08 HKT 2006

没有做过这么大的项目, 你的文章让我又想起曾经上软件工程课所经历的痛苦. :-(

-- 
http://codeplayer.blogbus.com/
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.exoweb.net/pipermail/python-chinese/attachments/20060802/f36a63b7/attachment.html

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2006年08月02日 星期三 20:25

Ai92 yuanyk at gmail.com
Wed Aug 2 20:25:23 HKT 2006

呵呵,看来我的帖子写的枯燥了些
不知道有没有遇到同样问题的同仁?


2006/8/2, yi huang <yi.codeplayer at gmail.com>:
>
> 没有做过这么大的项目, 你的文章让我又想起曾经上软件工程课所经历的痛苦. :-(
>
> --
> http://codeplayer.blogbus.com/
>
> _______________________________________________
> python-chinese
> Post: send python-chinese at lists.python.cn
> Subscribe: send subscribe to python-chinese-request at lists.python.cn
> Unsubscribe: send unsubscribe to  python-chinese-request at lists.python.cn
> Detail Info: http://python.cn/mailman/listinfo/python-chinese
>
>


-- 
此致
                            敬礼
************************************************
苑永凯
所在公司:山东中创软件商用中间件公司 InforFlow产品组
个人邮件: yuanyk at gmail.com
个人网址: http://blog.csdn.net/ai92
************************************************
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.exoweb.net/pipermail/python-chinese/attachments/20060802/b869a32d/attachment.html

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2006年08月02日 星期三 22:09

wang yingqi wangyingqi at gmail.com
Wed Aug 2 22:09:27 HKT 2006

中小项目的开发文档应该与代码的关系更紧密些,而大型项目的文档应该更关心框架而不是实现,除了需求文档以外,设计文档不应该写的过于详细,如果开发周期比较长,
那么十有八九文档都是过期的.而需求文档是测试后期跟踪的标本
,是应该明确的,这可以避免发布前的程序/需求/测试三方扯皮的情况出现.因此我个人比较提倡代码文档化,注释详细,甚至有工具直接将代码中的规范注释变为API手册,
接口说明等.没有几个程序员喜欢翻阅项目前人的文档.甚至说将数据定义,接口规范都放在单独的文档中,
维护成本太高.也是不太自然的事情.在我们还没成为印度软件工厂中的机器之前,我们还是尽量的避开形式大于效果的框框!

On 8/2/06, Ai92 <yuanyk at gmail.com> wrote:
>
>  呵呵,看来我的帖子写的枯燥了些
> 不知道有没有遇到同样问题的同仁?
>
>
> 2006/8/2, yi huang <yi.codeplayer at gmail.com>:
> >
> >  没有做过这么大的项目, 你的文章让我又想起曾经上软件工程课所经历的痛苦. :-(
>
> --
> http://codeplayer.blogbus.com/
>
> _______________________________________________
> python-chinese
> Post: send python-chinese at lists.python.cn
> Subscribe: send subscribe to python-chinese-request at lists.python.cn
> Unsubscribe: send unsubscribe to  python-chinese-request at lists.python.cn
> Detail Info: http://python.cn/mailman/listinfo/python-chinese
>
>
>
>
> --
> 此致
>                             敬礼
> ************************************************
> 苑永凯
> 所在公司:山东中创软件商用中间件公司 InforFlow产品组
>
> 个人邮件: yuanyk at gmail.com
> 个人网址: http://blog.csdn.net/ai92
> ************************************************
>
> _______________________________________________
> python-chinese
> Post: send python-chinese at lists.python.cn
> Subscribe: send subscribe to python-chinese-request at lists.python.cn
> Unsubscribe: send unsubscribe to  python-chinese-request at lists.python.cn
> Detail Info: http://python.cn/mailman/listinfo/python-chinese
>
>


-- 
wangyingqi
c++/python/palm/
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.exoweb.net/pipermail/python-chinese/attachments/20060802/2f7478a4/attachment.html

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2006年08月02日 星期三 22:16

IQDoctor huanghao.c at gmail.com
Wed Aug 2 22:16:19 HKT 2006

粗略看了一下。
我也遇到很多关于项目规划的问题,我在我们团队中
是唯一一个坚持写文档的人, 但只是细化到 API 文档这个层面,通常
程序完成,API 文档也就完成了。
我一直试图说服领导把更多的时间用于设计与文档方面,其实我们团队中对于软件工程熟悉的人很多,都知道重要性,但是没办法,环境不允许去做这些事情。首要的事情是如何把产品比竞争对手更快的生产出来,买给客户,拿到钱,继续维持公司运作,这对于我们这些中小型公司的情况来说这才是最重要的。



在 06-8-2,Ai92<yuanyk at gmail.com> 写道:
>
> 呵呵,看来我的帖子写的枯燥了些
> 不知道有没有遇到同样问题的同仁?
>
>
> 2006/8/2, yi huang <yi.codeplayer at gmail.com>:
> >
>
> 没有做过这么大的项目, 你的文章让我又想起曾经上软件工程课所经历的痛苦. :-(
>
> --
> http://codeplayer.blogbus.com/
> _______________________________________________
> python-chinese
> Post: send python-chinese at lists.python.cn
> Subscribe: send subscribe to
> python-chinese-request at lists.python.cn
> Unsubscribe: send unsubscribe to
> python-chinese-request at lists.python.cn
> Detail Info:
> http://python.cn/mailman/listinfo/python-chinese
>
>
>
>
> --
> 此致
>                             敬礼
> ************************************************
> 苑永凯
> 所在公司:山东中创软件商用中间件公司 InforFlow产品组
>
> 个人邮件: yuanyk at gmail.com
> 个人网址: http://blog.csdn.net/ai92
> ************************************************
> _______________________________________________
> python-chinese
> Post: send python-chinese at lists.python.cn
> Subscribe: send subscribe to
> python-chinese-request at lists.python.cn
> Unsubscribe: send unsubscribe to
> python-chinese-request at lists.python.cn
> Detail Info:
> http://python.cn/mailman/listinfo/python-chinese
>
>


-- 
Best regrads,
IQDoctor

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2006年08月03日 星期四 08:21

郭丹 mark.guo at gmail.com
Thu Aug 3 08:21:23 HKT 2006

我同意.
我觉得单元测试用例和类似Javadoc的借口文档基本上就足够了.
跟踪一份详细设计文档的成本还是挺高的.

On 8/2/06, wang yingqi <wangyingqi at gmail.com> wrote:
> 中小项目的开发文档应该与代码的关系更紧密些,而大型项目的文档应该更关心框架而不是实现,除了需求文档以外,设计文档不应该写的过于详细,如果开发周期比较长,那么十有八九文档都是过期的.而需求文档是测试后期跟踪的标本,是应该明确的,这可以避免发布前的程序/需求/测试三方扯皮的情况出现.因此我个人比较提倡代码文档化,注释详细,甚至有工具直接将代码中的规范注释变为API手册,接口说明等.没有几个程序员喜欢翻阅项目前人的文档.甚至说将数据定义,接口规范都放在单独的文档中,
> 维护成本太高.也是不太自然的事情.在我们还没成为印度软件工厂中的机器之前,我们还是尽量的避开形式大于效果的框框!
>
>
> On 8/2/06, Ai92 <yuanyk at gmail.com> wrote:
> >
>
> 呵呵,看来我的帖子写的枯燥了些
> 不知道有没有遇到同样问题的同仁?
>
>
> 2006/8/2, yi huang <yi.codeplayer at gmail.com>:
> >
>
> 没有做过这么大的项目, 你的文章让我又想起曾经上软件工程课所经历的痛苦. :-(
>
> --
> http://codeplayer.blogbus.com/
> _______________________________________________
> python-chinese
> Post: send python-chinese at lists.python.cn
> Subscribe: send subscribe to
> python-chinese-request at lists.python.cn
> Unsubscribe: send unsubscribe to
> python-chinese-request at lists.python.cn
> Detail Info:
> http://python.cn/mailman/listinfo/python-chinese
>
>
>
>
> --
> 此致
>                             敬礼
> ************************************************
> 苑永凯
> 所在公司:山东中创软件商用中间件公司 InforFlow产品组
>
> 个人邮件: yuanyk at gmail.com
> 个人网址: http://blog.csdn.net/ai92
> ************************************************
> _______________________________________________
>
> python-chinese
> Post: send python-chinese at lists.python.cn
> Subscribe: send subscribe to
> python-chinese-request at lists.python.cn
> Unsubscribe: send unsubscribe to
> python-chinese-request at lists.python.cn
> Detail Info:
> http://python.cn/mailman/listinfo/python-chinese
>
>
>
>
>
> --
> wangyingqi
> c++/python/palm/
> _______________________________________________
> python-chinese
> Post: send python-chinese at lists.python.cn
> Subscribe: send subscribe to
> python-chinese-request at lists.python.cn
> Unsubscribe: send unsubscribe to
> python-chinese-request at lists.python.cn
> Detail Info:
> http://python.cn/mailman/listinfo/python-chinese
>
>


-- 
"No More"
Mark's Blog  @ www.throughworks.com

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2006年08月03日 星期四 08:26

Ai92 yuanyk at gmail.com
Thu Aug 3 08:26:10 HKT 2006

我想知道IQDoctor 你的文档写来的作用是什么?
有人会去看吗?你能保证同步吗?
一般工作量占多大比重?


在06-8-2,IQDoctor <huanghao.c at gmail.com> 写道:
>
> 粗略看了一下。
> 我也遇到很多关于项目规划的问题,我在我们团队中
> 是唯一一个坚持写文档的人, 但只是细化到 API 文档这个层面,通常
> 程序完成,API 文档也就完成了。
>
> 我一直试图说服领导把更多的时间用于设计与文档方面,其实我们团队中对于软件工程熟悉的人很多,都知道重要性,但是没办法,环境不允许去做这些事情。首要的事情是如何把产品比竞争对手更快的生产出来,买给客户,拿到钱,继续维持公司运作,这对于我们这些中小型公司的情况来说这才是最重要的。
> --
> Best regrads,
> IQDoctor
>
> _______________________________________________
> python-chinese
> Post: send python-chinese at lists.python.cn
> Subscribe: send subscribe to python-chinese-request at lists.python.cn
> Unsubscribe: send unsubscribe to  python-chinese-request at lists.python.cn
> Detail Info: http://python.cn/mailman/listinfo/python-chinese
>
>
> --
> 此致
>                             敬礼
> ************************************************
> 苑永凯
> 所在公司:山东中创软件商用中间件公司 InforFlow产品组
> 个人邮件: yuanyk at gmail.com
> 个人网址: http://blog.csdn.net/ai92
> ************************************************
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.exoweb.net/pipermail/python-chinese/attachments/20060803/258918e4/attachment.html

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2006年08月03日 星期四 08:36

newboytim newboytim at 163.com
Thu Aug 3 08:36:26 HKT 2006

文档都是给开发者看的
而且看得很会很多
因为要做到整体结构严紧
例如
你可能会自己写一些专用的方法,你的个系统上都会用的上
对别人,他们不可能会记得那么清楚那些专用的方法
那样你的文档就用了
对你自己,要做的事很多,不可能每一件事都记得很清楚
不清楚的地方你可以通过文档了解到
老话说的好
好记忆不如烂笔头
  ----- Original Message ----- 
  From: Ai92 
  To: python-chinese at lists.python.cn 
  Sent: Thursday, August 03, 2006 8:26 AM
  Subject: Re: [python-chinese] [谈谈设计]关于详细设计


  我想知道IQDoctor 你的文档写来的作用是什么?
  有人会去看吗?你能保证同步吗?
  一般工作量占多大比重?

   
  在06-8-2,IQDoctor <huanghao.c at gmail.com> 写道: 
    粗略看了一下。
    我也遇到很多关于项目规划的问题,我在我们团队中
    是唯一一个坚持写文档的人, 但只是细化到 API 文档这个层面,通常
    程序完成,API 文档也就完成了。
    我一直试图说服领导把更多的时间用于设计与文档方面,其实我们团队中对于软件工程熟悉的人很多,都知道重要性,但是没办法,环境不允许去做这些事情。首要的事情是如何把产品比竞争对手更快的生产出来,买给客户,拿到钱,继续维持公司运作,这对于我们这些中小型公司的情况来说这才是最重要的。 
    --
    Best regrads,
    IQDoctor

    _______________________________________________
    python-chinese
    Post: send python-chinese at lists.python.cn
    Subscribe: send subscribe to python-chinese-request at lists.python.cn
    Unsubscribe: send unsubscribe to  python-chinese-request at lists.python.cn 
    Detail Info: http://python.cn/mailman/listinfo/python-chinese


    -- 
    此致
                                敬礼
    ************************************************ 
    苑永凯
    所在公司:山东中创软件商用中间件公司 InforFlow产品组
    个人邮件: yuanyk at gmail.com
    个人网址: http://blog.csdn.net/ai92
    ************************************************ 


------------------------------------------------------------------------------


  _______________________________________________
  python-chinese
  Post: send python-chinese at lists.python.cn
  Subscribe: send subscribe to python-chinese-request at lists.python.cn
  Unsubscribe: send unsubscribe to  python-chinese-request at lists.python.cn
  Detail Info: http://python.cn/mailman/listinfo/python-chinese
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.exoweb.net/pipermail/python-chinese/attachments/20060803/50ca292a/attachment.html

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2006年08月03日 星期四 08:48

Ai92 yuanyk at gmail.com
Thu Aug 3 08:48:42 HKT 2006

我没有质疑文档(注意这里的文档是广义的定义)的作用。而是质疑文档的纪录方式,比如套用模版的未经任何裁剪的word文档。
我认为这是最笨的一种纪录方式。


在06-8-3,newboytim <newboytim at 163.com> 写道:
>
>  文档都是给开发者看的
> 而且看得很会很多
> 因为要做到整体结构严紧
> 例如
> 你可能会自己写一些专用的方法,你的个系统上都会用的上
> 对别人,他们不可能会记得那么清楚那些专用的方法
> 那样你的文档就用了
> 对你自己,要做的事很多,不可能每一件事都记得很清楚
> 不清楚的地方你可以通过文档了解到
> 老话说的好
> 好记忆不如烂笔头
>
>  ----- Original Message -----
> *From:* Ai92 <yuanyk at gmail.com>
> *To:* python-chinese at lists.python.cn
> *Sent:* Thursday, August 03, 2006 8:26 AM
> *Subject:* Re: [python-chinese] [谈谈设计]关于详细设计
>
>
> 我想知道IQDoctor 你的文档写来的作用是什么?
> 有人会去看吗?你能保证同步吗?
> 一般工作量占多大比重?
>
>
> 在06-8-2,IQDoctor <huanghao.c at gmail.com> 写道:
> >
> > 粗略看了一下。
> > 我也遇到很多关于项目规划的问题,我在我们团队中
> > 是唯一一个坚持写文档的人, 但只是细化到 API 文档这个层面,通常
> > 程序完成,API 文档也就完成了。
> > 我一直试图说服领导把更多的时间用于设计与文档方面,其实我们团队中对于软件工程熟悉的人很多,都知道重要性,但是没办法,环境不允许去做这些事情。首要的事情是如何把产品比竞争对手更快的生产出来,买给客户,拿到钱,继续维持公司运作,这对于我们这些中小型公司的情况来说这才是最重要的。
> >
> > --
> > Best regrads,
> > IQDoctor
> >
> > _______________________________________________
> > python-chinese
> > Post: send python-chinese at lists.python.cn
> > Subscribe: send subscribe to python-chinese-request at lists.python.cn
> > Unsubscribe: send unsubscribe to  python-chinese-request at lists.python.cn
> >
> > Detail Info: http://python.cn/mailman/listinfo/python-chinese
> >
> >
> > --
> > 此致
> >                             敬礼
> > ************************************************
> > 苑永凯
> > 所在公司:山东中创软件商用中间件公司 InforFlow产品组
> > 个人邮件: yuanyk at gmail.com
> > 个人网址: http://blog.csdn.net/ai92
> > ************************************************
>
>  ------------------------------
>
> _______________________________________________
> python-chinese
> Post: send python-chinese at lists.python.cn
> Subscribe: send subscribe to python-chinese-request at lists.python.cn
> Unsubscribe: send unsubscribe to  python-chinese-request at lists.python.cn
> Detail Info: http://python.cn/mailman/listinfo/python-chinese
>
>
> _______________________________________________
> python-chinese
> Post: send python-chinese at lists.python.cn
> Subscribe: send subscribe to python-chinese-request at lists.python.cn
> Unsubscribe: send unsubscribe to  python-chinese-request at lists.python.cn
> Detail Info: http://python.cn/mailman/listinfo/python-chinese
>
>


-- 
此致
                            敬礼
************************************************
苑永凯
所在公司:山东中创软件商用中间件公司 InforFlow产品组
个人邮件: yuanyk at gmail.com
个人网址: http://blog.csdn.net/ai92
************************************************
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.exoweb.net/pipermail/python-chinese/attachments/20060803/cf5b3a54/attachment.htm

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2006年08月03日 星期四 09:02

limodou limodou at gmail.com
Thu Aug 3 09:02:01 HKT 2006

On 8/3/06, Ai92 <yuanyk at gmail.com> wrote:
>
> 我没有质疑文档(注意这里的文档是广义的定义)的作用。而是质疑文档的纪录方式,比如套用模版的未经任何裁剪的word文档。
> 我认为这是最笨的一种纪录方式。
>
所谓设计文档,就是你的代码还没有编写出来为了交流,为了肯定你的方案而写的,因此肯定不能细到代码都出来了。只不过,我们一般进入了编程阶段就不再看文档和修改文档罢了。但其中肯定有不少的设计会发生变化。对于正在工作的人来说,因为他很熟悉,所以它认为可能并不重要,或不能看到更多的东西。但对于一个新手来说,首先看文档可能是先要做的,通过它可以了解项目的骨干,而不是陷入到代码海洋当中。好的文档很重要,但问题是,怎么写出好的文档,这是一个非常难的问题。

最近正在考虑"文学编程",将文档和代码写到一起将是非常好的方式。它不同于在代码中写注释。因为注释还是属于代码的一个语法结构。而文学编程的思想是在文章中嵌入代码。这样你写的首先是一份文档。侧重点不同。


-- 
I like python!
My Blog: http://www.donews.net/limodou
My Django Site: http://www.djangocn.org
NewEdit Maillist: http://groups.google.com/group/NewEdit

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2006年08月03日 星期四 09:08

Ai92 yuanyk at gmail.com
Thu Aug 3 09:08:31 HKT 2006

文学编程~~~~
不错的想法,不过不会最后写出来会是本书吧,哈哈,还会热卖:)开个玩笑

使用类似于javadoc这种东西来作为最后的设计文档,不一定要等代码都出来了。因为你可以采用
TDD的方式来进行设计。而其这个东西有语言的工具支持,同步不成问题(你可要记得该注释,如果连这都懒得做,就没话说了)。


在06-8-3,limodou <limodou at gmail.com> 写道:
>
> On 8/3/06, Ai92 <yuanyk at gmail.com> wrote:
> >
> > 我没有质疑文档(注意这里的文档是广义的定义)的作用。而是质疑文档的纪录方式,比如套用模版的未经任何裁剪的word文档。
> > 我认为这是最笨的一种纪录方式。
> >
>
> 所谓设计文档,就是你的代码还没有编写出来为了交流,为了肯定你的方案而写的,因此肯定不能细到代码都出来了。只不过,我们一般进入了编程阶段就不再看文档和修改文档罢了。但其中肯定有不少的设计会发生变化。对于正在工作的人来说,因为他很熟悉,所以它认为可能并不重要,或不能看到更多的东西。但对于一个新手来说,首先看文档可能是先要做的,通过它可以了解项目的骨干,而不是陷入到代码海洋当中。好的文档很重要,但问题是,怎么写出好的文档,这是一个非常难的问题。
>
>
> 最近正在考虑"文学编程",将文档和代码写到一起将是非常好的方式。它不同于在代码中写注释。因为注释还是属于代码的一个语法结构。而文学编程的思想是在文章中嵌入代码。这样你写的首先是一份文档。侧重点不同。
>
>
> --
> I like python!
> My Blog: http://www.donews.net/limodou
> My Django Site: http://www.djangocn.org
> NewEdit Maillist: http://groups.google.com/group/NewEdit
>
> _______________________________________________
> python-chinese
> Post: send python-chinese at lists.python.cn
> Subscribe: send subscribe to python-chinese-request at lists.python.cn
> Unsubscribe: send unsubscribe to  python-chinese-request at lists.python.cn
> Detail Info: http://python.cn/mailman/listinfo/python-chinese
>
>


-- 
此致
                            敬礼
************************************************
苑永凯
所在公司:山东中创软件商用中间件公司 InforFlow产品组
个人邮件: yuanyk at gmail.com
个人网址: http://blog.csdn.net/ai92
************************************************
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.exoweb.net/pipermail/python-chinese/attachments/20060803/72974d7c/attachment.html

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2006年08月03日 星期四 09:15

limodou limodou at gmail.com
Thu Aug 3 09:15:03 HKT 2006

On 8/3/06, Ai92 <yuanyk at gmail.com> wrote:
>
> 文学编程~~~~
> 不错的想法,不过不会最后写出来会是本书吧,哈哈,还会热卖:)开个玩笑
>
> 使用类似于javadoc这种东西来作为最后的设计文档,不一定要等代码都出来了。因为你可以采用
> TDD的方式来进行设计。而其这个东西有语言的工具支持,同步不成问题(你可要记得该注释,如果连这都懒得做,就没话说了)。
>
>
注释一般是对函数,类的说明。而文学编程不仅仅是这些,可以是任意的文档,可以描述算法,设计思想。总之你可以理解就是一篇文档。同时在文档中存在代码,而这些代码可以被工具抽取出来变成真正可行的程序。因此不象注释那样的简单。而且在文学编程中,代码块,文档块都是可以命名的,可以被相互引用。这一点一般的编程不会有命名的概念。如果你看到leo,那么它是以一种树形结构来展示你的逻辑结构,而不是一个对象树之类的程序结构。

javadoc是为了从代码中抽取文档,而文学编程我认为是从文档中抽取代码。

-- 
I like python!
My Blog: http://www.donews.net/limodou
My Django Site: http://www.djangocn.org
NewEdit Maillist: http://groups.google.com/group/NewEdit

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2006年08月03日 星期四 09:17

netkiller openunix at 163.com
Thu Aug 3 09:17:31 HKT 2006

""" 一直试图说服领导把更多的时间用于设计与文档方面 """
楼主,你不费口舌了.国内的公司是不会这么做的..不付合国情...

我们公司是CMM3 哈哈.我在公司做一年多了.还没见过公司的cmm文档.
只有简单的FRD文档即:功能需求文档.还有就是Design文档.设计文档.

python 有自己doc工具.类似二楼朋友说的..Javadoc 

----- Original Message ----- 
From: "IQDoctor" <huanghao.c at gmail.com>
To: <python-chinese at lists.python.cn>
Sent: Wednesday, August 02, 2006 10:16 PM
Subject: Re: [python-chinese] [谈谈设计]关于详细设计


> 粗略看了一下。
> 我也遇到很多关于项目规划的问题,我在我们团队中
> 是唯一一个坚持写文档的人, 但只是细化到 API 文档这个层面,通常
> 程序完成,API 文档也就完成了。
> 我一直试图说服领导把更多的时间用于设计与文档方面,其实我们团队中对于软件工程熟悉的人很多,都知道重要性,但是没办法,环境不允许去做这些事情。首要的事情是如何把产品比竞争对手更快的生产出来,买给客户,拿到钱,继续维持公司运作,这对于我们这些中小型公司的情况来说这才是最重要的。
>
>
>
> 在 06-8-2,Ai92<yuanyk at gmail.com> 写道:
>>
>> 呵呵,看来我的帖子写的枯燥了些
>> 不知道有没有遇到同样问题的同仁?
>>
>>
>> 2006/8/2, yi huang <yi.codeplayer at gmail.com>:
>> >
>>
>> 没有做过这么大的项目, 你的文章让我又想起曾经上软件工程课所经历的痛苦. :-(
>>
>> --
>> http://codeplayer.blogbus.com/
>> _______________________________________________
>> python-chinese
>> Post: send python-chinese at lists.python.cn
>> Subscribe: send subscribe to
>> python-chinese-request at lists.python.cn
>> Unsubscribe: send unsubscribe to
>> python-chinese-request at lists.python.cn
>> Detail Info:
>> http://python.cn/mailman/listinfo/python-chinese
>>
>>
>>
>>
>> --
>> 此致
>>                             敬礼
>> ************************************************
>> 苑永凯
>> 所在公司:山东中创软件商用中间件公司 InforFlow产品组
>>
>> 个人邮件: yuanyk at gmail.com
>> 个人网址: http://blog.csdn.net/ai92
>> ************************************************
>> _______________________________________________
>> python-chinese
>> Post: send python-chinese at lists.python.cn
>> Subscribe: send subscribe to
>> python-chinese-request at lists.python.cn
>> Unsubscribe: send unsubscribe to
>> python-chinese-request at lists.python.cn
>> Detail Info:
>> http://python.cn/mailman/listinfo/python-chinese
>>
>>
>
>
> -- 
> Best regrads,
> IQDoctor
>


--------------------------------------------------------------------------------


> _______________________________________________
> python-chinese
> Post: send python-chinese at lists.python.cn
> Subscribe: send subscribe to python-chinese-request at lists.python.cn
> Unsubscribe: send unsubscribe to  python-chinese-request at lists.python.cn
> Detail Info: http://python.cn/mailman/listinfo/python-chinese 




[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2006年08月03日 星期四 09:22

Ai92 yuanyk at gmail.com
Thu Aug 3 09:22:23 HKT 2006

谢谢limodou提供新的思路。这种方式的确是我从来没有想过的,完全是个陌生的概念。不知道现在有没有很好的案例,或者支持平台?

在06-8-3,limodou <limodou at gmail.com> 写道:
>
> On 8/3/06, Ai92 <yuanyk at gmail.com> wrote:
> >
> > 文学编程~~~~
> > 不错的想法,不过不会最后写出来会是本书吧,哈哈,还会热卖:)开个玩笑
> >
> > 使用类似于javadoc这种东西来作为最后的设计文档,不一定要等代码都出来了。因为你可以采用
> > TDD的方式来进行设计。而其这个东西有语言的工具支持,同步不成问题(你可要记得该注释,如果连这都懒得做,就没话说了)。
> >
> >
>
> 注释一般是对函数,类的说明。而文学编程不仅仅是这些,可以是任意的文档,可以描述算法,设计思想。总之你可以理解就是一篇文档。同时在文档中存在代码,而这些代码可以被工具抽取出来变成真正可行的程序。因此不象注释那样的简单。而且在文学编程中,代码块,文档块都是可以命名的,可以被相互引用。这一点一般的编程不会有命名的概念。如果你看到leo,那么它是以一种树形结构来展示你的逻辑结构,而不是一个对象树之类的程序结构。
>
> javadoc是为了从代码中抽取文档,而文学编程我认为是从文档中抽取代码。
>
> --
> I like python!
> My Blog: http://www.donews.net/limodou
> My Django Site: http://www.djangocn.org
> NewEdit Maillist: http://groups.google.com/group/NewEdit
>
> _______________________________________________
> python-chinese
> Post: send python-chinese at lists.python.cn
> Subscribe: send subscribe to python-chinese-request at lists.python.cn
> Unsubscribe: send unsubscribe to  python-chinese-request at lists.python.cn
> Detail Info: http://python.cn/mailman/listinfo/python-chinese
>
>


-- 
此致
                            敬礼
************************************************
苑永凯
所在公司:山东中创软件商用中间件公司 InforFlow产品组
个人邮件: yuanyk at gmail.com
个人网址: http://blog.csdn.net/ai92
************************************************
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.exoweb.net/pipermail/python-chinese/attachments/20060803/73369c45/attachment.html

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2006年08月03日 星期四 09:26

limodou limodou at gmail.com
Thu Aug 3 09:26:26 HKT 2006

On 8/3/06, netkiller <openunix at 163.com> wrote:
>
> """ 一直试图说服领导把更多的时间用于设计与文档方面 """
> 楼主,你不费口舌了.国内的公司是不会这么做的..不付合国情...
>
> 我们公司是CMM3 哈哈.我在公司做一年多了.还没见过公司的cmm文档.
> 只有简单的FRD文档即:功能需求文档.还有就是Design文档.设计文档.
>
> python 有自己doc工具.类似二楼朋友说的..Javadoc
>
从代码中抽取文档不是文学编程。不过我也正在考虑和学习。我正打算对reStructuredText作一些小的功能,可能自定义代码块。这样在写文档时将代码嵌在里面,通过一个工具,既可以生文档,还可以生成代码。

这个想法正在试验中。

-- 
I like python!
My Blog: http://www.donews.net/limodou
My Django Site: http://www.djangocn.org
NewEdit Maillist: http://groups.google.com/group/NewEdit

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2006年08月03日 星期四 09:31

limodou limodou at gmail.com
Thu Aug 3 09:31:57 HKT 2006

On 8/3/06, Ai92 <yuanyk at gmail.com> wrote:
> 谢谢limodou提供新的思路。这种方式的确是我从来没有想过的,完全是个陌生的概念。不知道现在有没有很好的案例,或者支持平台?
>
leo是一个python的工具。国内鲜有文学编程的东西,在啄木鸟社区的wiki上可能有一些。国外你可以查一查:

http://www.literateprogramming.com/

-- 
I like python!
My Blog: http://www.donews.net/limodou
My Django Site: http://www.djangocn.org
NewEdit Maillist: http://groups.google.com/group/NewEdit

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2006年08月03日 星期四 09:54

netkiller openunix at 163.com
Thu Aug 3 09:54:26 HKT 2006

linux kernel 程序里的注释并不多...但大家照样开发..哈哈..

----- Original Message ----- 
From: "limodou" <limodou at gmail.com>
To: <python-chinese at lists.python.cn>
Sent: Thursday, August 03, 2006 9:31 AM
Subject: Re: [python-chinese] [谈谈设计]关于详细设计


> On 8/3/06, Ai92 <yuanyk at gmail.com> wrote:
>> 谢谢limodou提供新的思路。这种方式的确是我从来没有想过的,完全是个陌生的概念。不知道现在有没有很好的案例,或者支持平台?
>>
> leo是一个python的工具。国内鲜有文学编程的东西,在啄木鸟社区的wiki上可能有一些。国外你可以查一查:
>
> http://www.literateprogramming.com/
>
> -- 
> I like python!
> My Blog: http://www.donews.net/limodou
> My Django Site: http://www.djangocn.org
> NewEdit Maillist: http://groups.google.com/group/NewEdit
>


--------------------------------------------------------------------------------


> _______________________________________________
> python-chinese
> Post: send python-chinese at lists.python.cn
> Subscribe: send subscribe to python-chinese-request at lists.python.cn
> Unsubscribe: send unsubscribe to  python-chinese-request at lists.python.cn
> Detail Info: http://python.cn/mailman/listinfo/python-chinese 




[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2006年08月03日 星期四 09:59

yi huang yi.codeplayer at gmail.com
Thu Aug 3 09:59:19 HKT 2006

单元测试应该是属于详细设计的一部分吧?


-- 
http://codeplayer.blogbus.com/
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.exoweb.net/pipermail/python-chinese/attachments/20060803/e0602fd4/attachment.html

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2006年08月03日 星期四 10:05

Ai92 yuanyk at gmail.com
Thu Aug 3 10:05:00 HKT 2006

单元测试和TDD中的测试还是有区别的。
单元测试应该不属于详细设计中的一部分吧。谨代表个人意见


2006/8/3, yi huang <yi.codeplayer at gmail.com>:
>
> 单元测试应该是属于详细设计的一部分吧?
>
>
>
> --
> http://codeplayer.blogbus.com/
>
> _______________________________________________
> python-chinese
> Post: send python-chinese at lists.python.cn
> Subscribe: send subscribe to python-chinese-request at lists.python.cn
> Unsubscribe: send unsubscribe to  python-chinese-request at lists.python.cn
> Detail Info: http://python.cn/mailman/listinfo/python-chinese
>
>

-- 
此致
                            敬礼
************************************************
苑永凯
所在公司:山东中创软件商用中间件公司 InforFlow产品组
个人邮件: yuanyk at gmail.com
个人网址: http://blog.csdn.net/ai92
************************************************
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.exoweb.net/pipermail/python-chinese/attachments/20060803/ade72537/attachment.htm

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2006年08月03日 星期四 10:18

IQDoctor huanghao.c at gmail.com
Thu Aug 3 10:18:08 HKT 2006

单元测试应归于详细设计的一部分(代码单元,逻辑单元),单元测试通常由 coder 编写吧。

在 06-8-3,Ai92<yuanyk at gmail.com> 写道:
>
> 单元测试和TDD中的测试还是有区别的。
> 单元测试应该不属于详细设计中的一部分吧。谨代表个人意见
>
>
> 2006/8/3, yi huang <yi.codeplayer at gmail.com>:
> >
>
> 单元测试应该是属于详细设计的一部分吧?
>
>
>
> --
> http://codeplayer.blogbus.com/
> _______________________________________________
>
> python-chinese
> Post: send python-chinese at lists.python.cn
> Subscribe: send subscribe to
> python-chinese-request at lists.python.cn
> Unsubscribe: send unsubscribe to
> python-chinese-request at lists.python.cn
> Detail Info:
> http://python.cn/mailman/listinfo/python-chinese
>
>
>
>
> --
> 此致
>                             敬礼
> ************************************************
> 苑永凯
> 所在公司:山东中创软件商用中间件公司 InforFlow产品组
> 个人邮件: yuanyk at gmail.com
> 个人网址: http://blog.csdn.net/ai92
> ************************************************
> _______________________________________________
> python-chinese
> Post: send python-chinese at lists.python.cn
> Subscribe: send subscribe to
> python-chinese-request at lists.python.cn
> Unsubscribe: send unsubscribe to
> python-chinese-request at lists.python.cn
> Detail Info:
> http://python.cn/mailman/listinfo/python-chinese
>
>


-- 
Best regrads,
IQDoctor

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2006年08月03日 星期四 10:24

limodou limodou at gmail.com
Thu Aug 3 10:24:32 HKT 2006

On 8/3/06, IQDoctor <huanghao.c at gmail.com> wrote:
> 单元测试应归于详细设计的一部分(代码单元,逻辑单元),单元测试通常由 coder 编写吧。
>
我记得测试计划算,单元测试只有进入编码才可能会有,不算吧。不过这些理论的东西也无所谓了。

-- 
I like python!
My Blog: http://www.donews.net/limodou
My Django Site: http://www.djangocn.org
NewEdit Maillist: http://groups.google.com/group/NewEdit

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

如下红色区域有误,请重新填写。

    你的回复:

    请 登录 后回复。还没有在Zeuux哲思注册吗?现在 注册 !

    Zeuux © 2025

    京ICP备05028076号