大家作为一个程序员写文档写的多么?

时间:2023-02-12 12:40:11
RT,什么内部测试文档,部分模块的详细设计文档,软件的使用说明手册,啥都要我写,真是烦燥。作为一个初级程序员你让我写代码就行了,写文档写的真的让我很不爽。。

随便在问个问题,大家公司里面开发用devexpress控件用的多不多?怎么我公司好像很钟爱这套控件,WINFROM,WPF,ASP.NET都用这个?貌似以前也没听说这个控件有多好嘛。。

25 个解决方案

#1


这个你应该感谢公司给你这么多机会锻炼你,我都碰不到文档的 大家作为一个程序员写文档写的多么?

#2


引用 1 楼 hyh553879809 的回复:
这个你应该感谢公司给你这么多机会锻炼你,我都碰不到文档的

程序员还是先锻炼好写代码的能力在说吧,代码都写不好,还写什么文档。

#3


理论也是重要的一方面,没有理论支持,编代码时会花费更多的时间,我觉得你的机会还不错了,我们都没有写文档的机会呀。

#4


确实不太好,时间稍长一点儿就容易被套进去,形成依赖。
不过既然你进来了,那只好慢慢去适应环境了
多关心分析问题和设计思路可能比熟悉那套控件更重要

PS:个人也比较反感过多的文档,但是必要的设计和说明文档,对于系统以后的扩展和维护还是很重要的

#5


写完代码再回来写点记忆而已。

#6


我们公司,文档也是我写,但是你说的那个devexpress控件,我还从来没用过!

#7


WINFROM 用 C1.FlexGrid
WebForm 只用 DataGrid,复杂表格 直接输出 HTML.

文档编写很重要,但写文档需要技巧,而不是盲目编写,
盲目编写不仅文档写不好,还会影响编程。

通常文档有 需求调研文档,比如去客户那里调研,
调研时要做好笔记,笔记必须很详细记录,通常可以
专门安排一个人来记录,并且佩带录音笔。
如果是连续多天调研,每天调研完后,晚上就整理当天的笔记,
整理完后,对一些存疑的地方记录下来,第二天再去问。

回到公司后,对调研文档做一次总结整理,


发一份我写的真实文档给你参照,复制过来格式变了。


XXX厂XX系统2010-2011调研报告
调研时间:2011年3月11日
调研地点:XXX厂
调研岗位:各个基层岗位
调研目的:
了解本榨季XX系统运行情况。
了解XX系统在使用过程中存在的问题。
对下个榨季系统需要改进的地方进行探讨。
调研概述:
    对 发证、调度、结算、过磅各岗位操作员进行了调研,    
  收集岗位人员在使用上存在的问题,以及改进的意见。
    经过调研后,了解到总体上,本榨季砍运和蔗款发放工作还是比较顺利开展,
  榨季期间,因为下雨天数较多,加之劳动力缺乏,砍运工作受一定影响。
    本榨季截至3月11日止,甘蔗总进厂量64万吨。

◆ 计划与发证

人员:XXX(总调)
职责:计划与发证
工作概述:
    每天早上,做第二天的砍蔗计划,填制大户和散户计划砍蔗表。
    计划表填完后,大户就直接在电脑里发证,散户通过电脑的砍蔗计划功能来发证。
计划表的填制:
    根据日榨量来计算每天需要安排的计划车数,每天平均计划600车左右。
    大户是填写每户的计划数,散户是填写每个生产队的计划数。
    将计划车数,按比例分摊给大户,比如大户100车,散户500车。
    然后按车类型分解,比如大户总车数100车,其中加长单头30,小平头30,全车40。
    大户最后分解到户,需要考虑 天气、路况、劳动力、运力均衡、砍蔗进度均衡等因素。
    散户按镇村队逐级分解,最后分解到队,考虑的因素同上。
计划表的调整:
    计划之后将计划数发给蔗农,然后根据蔗农电话反馈信息来调整计划。
比如蔗农反映缺少劳动力或下雨等因素,需要减少车数。
蔗农反馈有砍蔗队需要增加车数。
发证:
    填制好砍蔗计划表后,大户的发证,直接通过人工发证模块,点单来发。
    散户的发证,是通过砍蔗计划模块,输入各生产队的计划数来发证,根据签号安排到户。
    散户有时也点单发证,由下面上报一张安排的表格,填写每个队安排的签号。
    安排下去后,蔗农反馈砍不了,或者很长时间不报进,则需要作废。也有调整砍蔗时间.
    电脑发证后,通过发送短信通知蔗农和蔗管员,不打印砍蔗证。蔗管员督促蔗农砍蔗.
    要保证蔗管员一定能收到短信,通常每天下午,蔗管员还没收到短信,就会询问。

存在的问题:
散户通过计划模块发证时,每种车类型都要做一次计划,不能一次计划做完。
散户点单安排时,下面是按签号报的。人工发证模块,可以按签号安排,
但操作员不知道有此功能。按签号安排时,需要一次安排几个签号,
不用每个签号安排一次。
发证后,有时蔗农或蔗管员收不到短信。
发证后,有时提示系统错误“类型不匹配”,这种情况很少。
区域选择,无法输入编码来定位到区域。
农务快报,今日计划总车数,已派车数,已进厂车数等,需要按车类型分列出来。
超时未上点的任务,自动作废,签号排在最后。

改进的意见:
计划与发证,都是一个人完成,下达计划后,还要电话接听蔗农反馈意见,调整计划,加之本榨季下雨天多,点单多,散户点单占到3/5左右,工作量大。而计划到大户和队,
主要靠人工决策,电脑辅助很少。这里可以通过改进电脑砍蔗计划模块,
    提供更好的辅助计划信息,以及更方便的发证,来减轻计划和发证的工作量。
    对于一些超时未上点的任务,自动作废。
        
    
◆ 调度派车
    
人员:调度员
职责:上点派车
工作概述:蔗农报进,然后派车。
系统运行情况:
    本榨季实行里程均衡,本来是想自动派车,但实行几天,发现自动筛选出来的任务
并不合要求,需要选择其它的任务来派,比如劳服的车拉某个区域,又不属于定点,
无装车队的问题等。所以改成里程均衡的方式,
将符合里程均衡范围的任务全部列出来,给操作员自己去选择。
本来想增加透明度,给司机查看自己的任务,但因为可选择的任务太多,
司机喜欢挑选任务,而影响派车进度,只能不给司机查看派车任务。
    因为下雨,以及劳动力的问题,砍运不及时,而甘蔗运不出来,留种的甘蔗较多。

派车改进意见:
    筛选任务要公平合理,避免司机挑选任务,保证顺利派车。
    派车主界面,平均日运显示不对。
    

◆ 结算管理

人员:结算员
职责:蔗款发放、收购点数据导入与付款、预付款发放。
系统运行情况:
刚开榨一段时间,因为下雨,为鼓励砍蔗而增加砍蔗补贴。
榨季期间提高过蔗价,需要二次付款。包括收购点导入的过磅记录,也要二次付款。
一些大户几个区域都有甘蔗,影响预付款回收率。

系统存在的问题及改进意见:
    预付模块
进入预付业务模块,不能同时查看蔗农档案。
增加蔗种预付记录页面,有时不小心改了单价,而导致金额不对。
应该不允许在录入界面更改单价,只能在基础信息那里更改单价。
品种,调种方式,第一次录入后,第二次应该继续保留第一次的值,避免重新选择。 
选蔗农时,默认是按名字搜索,大多数情况是需要按编码搜索,需要切换搜索方式。
基础资料,增加机手的录入。机耕录入,需要选择机手,并查询打印机手报表。
机手报表格式见附录。
蔗种录入界面,需要录入编码来选择蔗种类型,删完类型最好从1开始编。
预付业务生成新榨季预付记录,需要自动填写扣款方式和队长。
队长默认第一个,普通户扣款方式是联保扣余额,大户是个人扣。
增加一个报表,查询有预付而无签记录的蔗农。
预付管理的蔗农扣款明细报表,数据有点杂乱,需要整理。
报表表格格式名称是公用的,而不是分用户。所以一些格式本来设置好了,又被别的操作员改了格式,导致打印出来的报表经常变化。最好分用户设置格式,设一个默认公用格式。
增加报表,按区域和时间段查询:总预付款,已回收预付款。需要同时统计本厂过磅回收的预付款,和收购点过磅回收的预付款。已回收需要包括现金。
预付款缓扣,本榨季采用缓扣车数,而实际情况是缓扣金额。
预付款管理,增加现金还款功能,和 预付款调整功能。

蔗款结算
收购点过磅主列表,没有打印、预览的功能。
收购点过磅主列表,将品种单价、补贴单价、装蔗费单价、春节补贴单价都列出来,方便核对数据。
收购点导入过磅记录,需要选择收购点,容易误操作,最好在Excel里填写好收购点,导入时自动读取收购点名称就行。
收购点对比表,收购点蔗款,和本厂蔗款,都要加上联动的金额。
蔗款兑付明细表,只选择一个村,所有村都出来了。选择条件后,下次重新查询,最好保留上次选择的条件。
报表:决策类-进厂记录明细,票类型要默认全部,加个总合计。
付款导出,没有权限控制。
报表:决策类-结算汇总表,火烧良种不显示出来,还有运费不对。
联动,结算明细表,导出Excel时,银行帐号是科学计数法。
蔗农档案的银行帐号,需要权限控制。

◆ 过磅管理
人员:过磅员
职责:甘蔗过磅
系统存在的问题及改进意见:
过磅列表发送短信,要很久,几百条记录,需要一个多小时才发的完。
过磅消单,没有记录消单操作员。
人工过磅,需要标识人工毛重,人工皮重,方便查询监督。

物资过磅:
采购物资回皮,选择车辆,自动带出其它信息,不用再选择物资。
保存时间太久。
能修改取皮信息,包括物资、车号、单位。
增加消皮功能。
重复取皮时,需要提示是否覆盖上次取皮记录。
取皮保存后,不关闭窗口,再输入车号,就不对应单位了。
采购重磅,输入车号物资,回车后,不自动加载运输单位和规格,
要等输入完往来单位才加载。
磅单打印格式设置太麻烦。
过磅列表,重磅时间改成进厂时间,轻磅时间改成出厂时间。
修改组权限,不能自动应用到所有用户。
过磅明细查询,报表,需要查询所有物资。选择 出售类,不能查询。
称量统计报表,物资列表,显示的是规格,取消出错。
物资列表的表格格式不好用,报表没有表格格式控制。
复核,要能一次复核完所有物资,不用一种一种物资去复核。
增加物资,编码自动取最大的。
往来单位车辆配置,看不到选择的车辆。
自动升级。

#8


其实程序员适当的谢谢文档,做做测试挺好的。可以让你对整个产品有一个清晰的认识,让你有机会站在更高的层面上去考虑问题。尤其是刚入行的新手。

#9



在前一个公司写的多。。。现在不用写。。

#10


正规流程写文档比写代码还多。

不过很多文档都是建模以后自动生成了。

#11


引用 9 楼 porschev 的回复:
在前一个公司写的多。。。现在不用写。。

现在做了领导文档都安排手下写了吧。呵呵。

#12


引用 10 楼 winner2050 的回复:
正规流程写文档比写代码还多。

不过很多文档都是建模以后自动生成了。

有啥好的建模工具?

#13


,不懂,帮顶,接分,走人。

#14


偶尔写写

#15


基本上不用寫哈,看文檔的情況還是較多的

#16


只写文档,不写代码了

#17


引用 16 楼 xxoo2007 的回复:
只写文档,不写代码了

项目经理了?

#18


引用 12 楼 f800051235 的回复:
引用 10 楼 winner2050 的回复:
正规流程写文档比写代码还多。

不过很多文档都是建模以后自动生成了。

有啥好的建模工具?


Enterprise Architect 8 汉化版

整个软件工程的所有模型都可以在里面建。

#19


 我觉得还是先写好代码,在写程序好些

#20


哥你都星星了还初级程序员啊。

#21


程序员有什么好的!
  很辛苦!

#22


不会写  见文档就头疼

#23


虽然这东西写的不多。。。但的确有好处。。。。

至于DevExpress。。。还是不错的控件来着

#24


七楼的那种方法不正规,应该用“建模”来解决。

#25


靠,我们经理天一什么都不干,什么写文档,编码,啥都不做,整天让我们做他份内的事

#1


这个你应该感谢公司给你这么多机会锻炼你,我都碰不到文档的 大家作为一个程序员写文档写的多么?

#2


引用 1 楼 hyh553879809 的回复:
这个你应该感谢公司给你这么多机会锻炼你,我都碰不到文档的

程序员还是先锻炼好写代码的能力在说吧,代码都写不好,还写什么文档。

#3


理论也是重要的一方面,没有理论支持,编代码时会花费更多的时间,我觉得你的机会还不错了,我们都没有写文档的机会呀。

#4


确实不太好,时间稍长一点儿就容易被套进去,形成依赖。
不过既然你进来了,那只好慢慢去适应环境了
多关心分析问题和设计思路可能比熟悉那套控件更重要

PS:个人也比较反感过多的文档,但是必要的设计和说明文档,对于系统以后的扩展和维护还是很重要的

#5


写完代码再回来写点记忆而已。

#6


我们公司,文档也是我写,但是你说的那个devexpress控件,我还从来没用过!

#7


WINFROM 用 C1.FlexGrid
WebForm 只用 DataGrid,复杂表格 直接输出 HTML.

文档编写很重要,但写文档需要技巧,而不是盲目编写,
盲目编写不仅文档写不好,还会影响编程。

通常文档有 需求调研文档,比如去客户那里调研,
调研时要做好笔记,笔记必须很详细记录,通常可以
专门安排一个人来记录,并且佩带录音笔。
如果是连续多天调研,每天调研完后,晚上就整理当天的笔记,
整理完后,对一些存疑的地方记录下来,第二天再去问。

回到公司后,对调研文档做一次总结整理,


发一份我写的真实文档给你参照,复制过来格式变了。


XXX厂XX系统2010-2011调研报告
调研时间:2011年3月11日
调研地点:XXX厂
调研岗位:各个基层岗位
调研目的:
了解本榨季XX系统运行情况。
了解XX系统在使用过程中存在的问题。
对下个榨季系统需要改进的地方进行探讨。
调研概述:
    对 发证、调度、结算、过磅各岗位操作员进行了调研,    
  收集岗位人员在使用上存在的问题,以及改进的意见。
    经过调研后,了解到总体上,本榨季砍运和蔗款发放工作还是比较顺利开展,
  榨季期间,因为下雨天数较多,加之劳动力缺乏,砍运工作受一定影响。
    本榨季截至3月11日止,甘蔗总进厂量64万吨。

◆ 计划与发证

人员:XXX(总调)
职责:计划与发证
工作概述:
    每天早上,做第二天的砍蔗计划,填制大户和散户计划砍蔗表。
    计划表填完后,大户就直接在电脑里发证,散户通过电脑的砍蔗计划功能来发证。
计划表的填制:
    根据日榨量来计算每天需要安排的计划车数,每天平均计划600车左右。
    大户是填写每户的计划数,散户是填写每个生产队的计划数。
    将计划车数,按比例分摊给大户,比如大户100车,散户500车。
    然后按车类型分解,比如大户总车数100车,其中加长单头30,小平头30,全车40。
    大户最后分解到户,需要考虑 天气、路况、劳动力、运力均衡、砍蔗进度均衡等因素。
    散户按镇村队逐级分解,最后分解到队,考虑的因素同上。
计划表的调整:
    计划之后将计划数发给蔗农,然后根据蔗农电话反馈信息来调整计划。
比如蔗农反映缺少劳动力或下雨等因素,需要减少车数。
蔗农反馈有砍蔗队需要增加车数。
发证:
    填制好砍蔗计划表后,大户的发证,直接通过人工发证模块,点单来发。
    散户的发证,是通过砍蔗计划模块,输入各生产队的计划数来发证,根据签号安排到户。
    散户有时也点单发证,由下面上报一张安排的表格,填写每个队安排的签号。
    安排下去后,蔗农反馈砍不了,或者很长时间不报进,则需要作废。也有调整砍蔗时间.
    电脑发证后,通过发送短信通知蔗农和蔗管员,不打印砍蔗证。蔗管员督促蔗农砍蔗.
    要保证蔗管员一定能收到短信,通常每天下午,蔗管员还没收到短信,就会询问。

存在的问题:
散户通过计划模块发证时,每种车类型都要做一次计划,不能一次计划做完。
散户点单安排时,下面是按签号报的。人工发证模块,可以按签号安排,
但操作员不知道有此功能。按签号安排时,需要一次安排几个签号,
不用每个签号安排一次。
发证后,有时蔗农或蔗管员收不到短信。
发证后,有时提示系统错误“类型不匹配”,这种情况很少。
区域选择,无法输入编码来定位到区域。
农务快报,今日计划总车数,已派车数,已进厂车数等,需要按车类型分列出来。
超时未上点的任务,自动作废,签号排在最后。

改进的意见:
计划与发证,都是一个人完成,下达计划后,还要电话接听蔗农反馈意见,调整计划,加之本榨季下雨天多,点单多,散户点单占到3/5左右,工作量大。而计划到大户和队,
主要靠人工决策,电脑辅助很少。这里可以通过改进电脑砍蔗计划模块,
    提供更好的辅助计划信息,以及更方便的发证,来减轻计划和发证的工作量。
    对于一些超时未上点的任务,自动作废。
        
    
◆ 调度派车
    
人员:调度员
职责:上点派车
工作概述:蔗农报进,然后派车。
系统运行情况:
    本榨季实行里程均衡,本来是想自动派车,但实行几天,发现自动筛选出来的任务
并不合要求,需要选择其它的任务来派,比如劳服的车拉某个区域,又不属于定点,
无装车队的问题等。所以改成里程均衡的方式,
将符合里程均衡范围的任务全部列出来,给操作员自己去选择。
本来想增加透明度,给司机查看自己的任务,但因为可选择的任务太多,
司机喜欢挑选任务,而影响派车进度,只能不给司机查看派车任务。
    因为下雨,以及劳动力的问题,砍运不及时,而甘蔗运不出来,留种的甘蔗较多。

派车改进意见:
    筛选任务要公平合理,避免司机挑选任务,保证顺利派车。
    派车主界面,平均日运显示不对。
    

◆ 结算管理

人员:结算员
职责:蔗款发放、收购点数据导入与付款、预付款发放。
系统运行情况:
刚开榨一段时间,因为下雨,为鼓励砍蔗而增加砍蔗补贴。
榨季期间提高过蔗价,需要二次付款。包括收购点导入的过磅记录,也要二次付款。
一些大户几个区域都有甘蔗,影响预付款回收率。

系统存在的问题及改进意见:
    预付模块
进入预付业务模块,不能同时查看蔗农档案。
增加蔗种预付记录页面,有时不小心改了单价,而导致金额不对。
应该不允许在录入界面更改单价,只能在基础信息那里更改单价。
品种,调种方式,第一次录入后,第二次应该继续保留第一次的值,避免重新选择。 
选蔗农时,默认是按名字搜索,大多数情况是需要按编码搜索,需要切换搜索方式。
基础资料,增加机手的录入。机耕录入,需要选择机手,并查询打印机手报表。
机手报表格式见附录。
蔗种录入界面,需要录入编码来选择蔗种类型,删完类型最好从1开始编。
预付业务生成新榨季预付记录,需要自动填写扣款方式和队长。
队长默认第一个,普通户扣款方式是联保扣余额,大户是个人扣。
增加一个报表,查询有预付而无签记录的蔗农。
预付管理的蔗农扣款明细报表,数据有点杂乱,需要整理。
报表表格格式名称是公用的,而不是分用户。所以一些格式本来设置好了,又被别的操作员改了格式,导致打印出来的报表经常变化。最好分用户设置格式,设一个默认公用格式。
增加报表,按区域和时间段查询:总预付款,已回收预付款。需要同时统计本厂过磅回收的预付款,和收购点过磅回收的预付款。已回收需要包括现金。
预付款缓扣,本榨季采用缓扣车数,而实际情况是缓扣金额。
预付款管理,增加现金还款功能,和 预付款调整功能。

蔗款结算
收购点过磅主列表,没有打印、预览的功能。
收购点过磅主列表,将品种单价、补贴单价、装蔗费单价、春节补贴单价都列出来,方便核对数据。
收购点导入过磅记录,需要选择收购点,容易误操作,最好在Excel里填写好收购点,导入时自动读取收购点名称就行。
收购点对比表,收购点蔗款,和本厂蔗款,都要加上联动的金额。
蔗款兑付明细表,只选择一个村,所有村都出来了。选择条件后,下次重新查询,最好保留上次选择的条件。
报表:决策类-进厂记录明细,票类型要默认全部,加个总合计。
付款导出,没有权限控制。
报表:决策类-结算汇总表,火烧良种不显示出来,还有运费不对。
联动,结算明细表,导出Excel时,银行帐号是科学计数法。
蔗农档案的银行帐号,需要权限控制。

◆ 过磅管理
人员:过磅员
职责:甘蔗过磅
系统存在的问题及改进意见:
过磅列表发送短信,要很久,几百条记录,需要一个多小时才发的完。
过磅消单,没有记录消单操作员。
人工过磅,需要标识人工毛重,人工皮重,方便查询监督。

物资过磅:
采购物资回皮,选择车辆,自动带出其它信息,不用再选择物资。
保存时间太久。
能修改取皮信息,包括物资、车号、单位。
增加消皮功能。
重复取皮时,需要提示是否覆盖上次取皮记录。
取皮保存后,不关闭窗口,再输入车号,就不对应单位了。
采购重磅,输入车号物资,回车后,不自动加载运输单位和规格,
要等输入完往来单位才加载。
磅单打印格式设置太麻烦。
过磅列表,重磅时间改成进厂时间,轻磅时间改成出厂时间。
修改组权限,不能自动应用到所有用户。
过磅明细查询,报表,需要查询所有物资。选择 出售类,不能查询。
称量统计报表,物资列表,显示的是规格,取消出错。
物资列表的表格格式不好用,报表没有表格格式控制。
复核,要能一次复核完所有物资,不用一种一种物资去复核。
增加物资,编码自动取最大的。
往来单位车辆配置,看不到选择的车辆。
自动升级。

#8


其实程序员适当的谢谢文档,做做测试挺好的。可以让你对整个产品有一个清晰的认识,让你有机会站在更高的层面上去考虑问题。尤其是刚入行的新手。

#9



在前一个公司写的多。。。现在不用写。。

#10


正规流程写文档比写代码还多。

不过很多文档都是建模以后自动生成了。

#11


引用 9 楼 porschev 的回复:
在前一个公司写的多。。。现在不用写。。

现在做了领导文档都安排手下写了吧。呵呵。

#12


引用 10 楼 winner2050 的回复:
正规流程写文档比写代码还多。

不过很多文档都是建模以后自动生成了。

有啥好的建模工具?

#13


,不懂,帮顶,接分,走人。

#14


偶尔写写

#15


基本上不用寫哈,看文檔的情況還是較多的

#16


只写文档,不写代码了

#17


引用 16 楼 xxoo2007 的回复:
只写文档,不写代码了

项目经理了?

#18


引用 12 楼 f800051235 的回复:
引用 10 楼 winner2050 的回复:
正规流程写文档比写代码还多。

不过很多文档都是建模以后自动生成了。

有啥好的建模工具?


Enterprise Architect 8 汉化版

整个软件工程的所有模型都可以在里面建。

#19


 我觉得还是先写好代码,在写程序好些

#20


哥你都星星了还初级程序员啊。

#21


程序员有什么好的!
  很辛苦!

#22


不会写  见文档就头疼

#23


虽然这东西写的不多。。。但的确有好处。。。。

至于DevExpress。。。还是不错的控件来着

#24


七楼的那种方法不正规,应该用“建模”来解决。

#25


靠,我们经理天一什么都不干,什么写文档,编码,啥都不做,整天让我们做他份内的事