A. 软件开发中的 概要设计文档 详细设计文档在正常情况下 是不是程序员写的吧!
一个项目设计是最重要的。其实现在在技术上难题不多。同一个公司你不会肯定有别人会,相互问问就好。最关键的是需求理解。所以开发人员自己写详细设计是很有好处的。譬如我现在在平安科技。我们的流程时:客户将需求讲解给SA(需求分析师),SA理解之后在召集开发人员一起讲解,最后由开发人员自己设计并将设计文稿发出去由负责人及SA评估。 如果没有问题就会按照详细设计来开发。 这样的话虽然设计花费了一定的开发时间,但是在熟悉需求的基础上开发可谓是:磨刀不误砍柴工!
望采纳。 谢谢
B. 程序员交接时有讲解代码写文档的义务么
需要
比如 api接口文档、部署文档、技术文档之类的
虽然写起来会有些痛苦,但好处还是挺多的。
1.方便工作交接。无论是功能后续开发让同事接手还是离职交接,有文档在,都可以省力一点。通过文档,知道的就清晰明了。
2.方便后来查阅。时间久了总会忘掉一些细节,如果突发一个bug,都可能无从下手。如果有了文档,之后就很好查阅了。遇到那种代码超长的,同时又没注释,想要改的时候又无从下手...文档多重要啊
3.还可以锻炼自己的写作和表达能力!很多时候教会别人比自己学会更有成就感!而且对自己的写作能力也是一种锻炼,何乐而不为呢?
所以,程序员交接时就讲解代码和写写文档吧
C. 程序员如何写好技术文档建议收藏
程序员的世界,技术文档如同导航灯,照亮协作之路。它不仅是信息的共享殿堂,更是知识的传承桥梁,为团队效率的提升发挥着关键作用。
首先,技术文档的价值不容忽视。它是一种有效的信息库,能避免不必要的重复劳动,方便快速检索和传授知识。通过精准记录,每个问题的解答都能成为他人学习的阶梯,节省宝贵的时间。更重要的是,一份高质量的文档,能够塑造团队的专业形象,提升协作效率,让团队成员在共享的智慧海洋中更顺畅地航行。
当然,有人质疑,为何要花费时间在文档上。然而,这正是我们引入版本管理和历史记录的初衷。过时的文档并非负担,而是历史的见证,它们作为知识的沉淀,同样具有价值。维护文档时,应明确区分代码细节与设计变更,确保文档始终紧跟代码步伐,鲜活且实用。
那么,怎样的技术文档才能经得起时间的考验?它需要具备敏捷性,简洁明了,结构清晰,让人一目了然。理想的文档,就像一座地图,用图表和示例引导读者,让复杂的概念变得直观易懂。结构上,从引言、目录到术语解析,再到详细的步骤和附录,如FAQ、日志和版本记录,都应井井有条。
写作技术文档并非单纯地记录,而是结构化整理,为他人思考和使用而设。遵循认知的准则,如理解内容、换位思考,以及MECE原则(Mutually Exclusive and Collectively Exhaustive),确保信息的全面性和一致性。
在工具的选择上,Markdown因其开源和易用性,成为了程序员的首选,如Asciidoc则提供了更强大的排版能力,但语法相对复杂。Latex在学术界流行,但过度使用可能导致文档变得冗长。推荐使用Git进行版本控制,配合静态网站生成工具,让文档管理更加高效。
总结来说,技术文档是团队协作的得力助手,它强调的是文档的维护更新、易用性和结构化设计。通过遵循上述原则和方法,我们不仅能写出高效实用的文档,还能提升整个团队的协作效率。记住,每一份精心撰写的文档,都是对知识的尊重和团队智慧的传承。
D. java面试官问有没有写过文档(面试java程序员),我想知道写文档是指什么,是设计文档还是需求文档还是其他
我想他的文档是来指在项目开发过源程中 不同阶段的文档
我们项目组开发基本是基于瀑布模型开发 每个阶段都会输出文档指导后续工作开展
一般se下发需求后 由我们出 详细需求设计文档
代码开发完成了 转测试时我们会写 数据库设计文档 ,操作手册 (这个也算)
还有就是 版本升级说明书 版本功能清单 软件介绍
这个是大概的文档 还有其他的...文档编写时间 主要是代码开发前 与 转测试后
E. 作为程序员如何书写技术文档
按自己的喜好去写,没有具体的格式,不过要写名程序的用途,代码的函数使用方法,变量的意义等内容