规范化代码编写,编写自文档化的代码

文所以载道也。 —— 宋·周敦颐《通书·文辞》对于我们程序员来说,我们的工作也是写作——几乎每天都要写代码;而且还要载“道”,不仅仅要满足客户的需求,还要让代码具有高度的可读性,这样其他的程序员可以更容易地对代码进行修改和扩展。按这样的要求,我们需要为代码编写足够的文档,也就是将代码“... [阅读全文]

软件文档编写:编写优秀技术文档的窍门技巧

拥有准确技术文档不仅对于公司是非常有益处而且也能够让客户从中受益由于产品如何使用在某种程度上是要依赖技术文档来进行介绍说明因此技术文档必须十分准确可靠使用不准确和已经过时技术文档对于公司发展也会产生定阻碍同样它也会对公司客户们产生消极影响旦客户发现在他们使用产品时候遇到了问题却不能通过求助于伴随产品技术文档手段进行解决时候客户们就会对这种产品产生怀疑乃至于失去信心那么公司信誉和利益自然而然就会受到... [阅读全文]

文档编写:关于软件文档编写培训的邮件及内容

把培训的内容列在下面,就是希望有时间的时候,多研究一下,映射到自身,看看自己还有哪些不足,是否能从中学到点儿什么,这才是最主要的目的。 下面贴的就是培训的内容,已经过整理。 面向对象: 项目经理、架构师、设计师、质量保证人员、 配置管理人员、开发与测试人员。 课程目标: 掌握软件各主要文档的撰写方法和技巧:包括需求文档、架构文档、设计文档... [阅读全文]
1 共1条 分1页