`
DigitalSonic
  • 浏览: 215110 次
社区版块
存档分类
最新评论

原来我也会写文档

阅读更多
一直都很反感写文档,觉得比起文档我更愿意花时间写代码,虽然都是费时费力的活儿,但我还是比较喜欢写代码,呵呵。
这两天静下心来闷头为自己写的一个小框架写说明,或者说是使用指南。从头开始就一个人坐那里边写边抱怨,可是抱怨好了继续写……大框架搭好后就开始像填充一样的写一个个小章节,也许是文档看多了,写着写着觉得写文档其实和写作文还是不一样的,毕竟不是写散文小说……虽说如此,可我还是不太乐意写文档,估计程序员都差不多吧。
等到初稿完成时,看看页数,算上封面8页,当中嵌了些范例的代码,大大小小几级标题,还是蛮漂亮的,回头想想,写文档嘛也就这点事
分享到:
评论

相关推荐

    写文档的艺术

    标题“写文档的艺术”指的是在IT行业中,撰写技术文档的重要性以及如何有效地进行文档编写。一个良好的文档能够清晰地传达项目信息,帮助团队协作,降低沟通成本,并为后续维护和升级提供依据。这篇博客可能深入探讨...

    程序员如何写文档

    程序员如何写文档

    教你如何写好文档--文档编写技巧

    这种敬业精神会体现在文档的质量上,让读者感受到作者的用心。 2. **了解读者**:在编写文档之前,必须深入理解目标读者群体。考虑他们的技术水平、阅读习惯和期望,使文档内容易于理解且有针对性。确保语言和内容...

    C++下读写复合文档演示程序

    同时,熟悉所选用的库的API文档和使用示例也非常重要。在开发过程中,需要注意错误处理和资源管理,以确保程序的稳定性和可靠性。 总的来说,C++下读写复合文档是一项挑战性的工作,需要掌握多种技能和库。通过实践...

    文档模板(学习怎样写文档)

    "文档模板(学习怎样写文档)"这个资源显然是为了帮助那些对文档写作感到困惑或者想提升文档编写能力的人准备的。下面将详细介绍文档模板及其在学习文档编写中的作用。 首先,我们要明白什么是文档模板。模板是预先...

    Typora编辑器 比较实用的一款编辑器 写文档很方便 说明文档.rar

    Typora编辑器 比较实用的一款编辑器 写文档很方便 说明文档

    教你怎样写软件开发文档2

    本文将详细介绍如何撰写一份出色的软件开发文档,以“教你怎样写软件开发文档2”为主题,结合实际的“软件开发规范文档”为例,探讨其核心内容。 1. **需求分析文档** 需求分析文档是项目启动阶段的关键产出,它...

    应该如何写好需求文档

    由于需求文档通常会递交给非技术人员,如客户或业务代表,因此文档的语言应简洁明了,避免使用过于专业或技术性的词汇。例如,避免使用“普通用户”、“超级管理员”等术语,而是用更通俗易懂的词语来描述不同的用户...

    教你怎么写开发文档

    开发文档是软件开发过程中的重要组成部分,它详细记录了项目的各个阶段,确保团队成员、管理者以及最终用户对软件的理解一致。...同时,文档应当简洁明了,避免过于技术性的术语,让非技术人员也能理解。

    html文档模板(实现用html写出优雅的文档)

    提供了一个模板,使用该模板,可以通过html语言写出优雅的文档。该模板包含了CSS文件和JS文件,分别用于文档的样式设置和目录的自动生成,这两个文件不需要做修改。用户的文档写在其中的html文件中。由于html的跨...

    你写我读(在编辑文档中读出你写的内容

    【标题】"你写我读(在编辑文档中读出你写的内容"涉及的主要知识点是文本编辑器的辅助功能,特别是语音合成技术在文档编辑中的应用。这一特性旨在提高文字输入效率,尤其对使用五笔输入法或其他复杂输入法的用户而言...

    国家标准-软件文档 写文档必备

    掌握《国家标准-软件文档 写文档必备》中的内容,不仅能够提升个人的专业素养,也是团队协作和项目成功的关键。对于企业而言,遵循这些标准可以提升整体的软件开发质量和效率,降低后期维护的成本。因此,无论是个人...

    如何写好后端产品需求文档,这几个问题需要注意.docx

    后端产品需求文档是连接产品、开发和测试的关键桥梁,其质量直接影响项目的进度和最终产品的质量。撰写良好的需求文档能够确保团队对需求有清晰、一致...只有这样,才能写出一份高质量的需求文档,推动项目的顺利进行。

    AI 硬件产品需求文档(PRD)怎么写?.docx

    AI 硬件产品需求文档(PRD)写作指南 AI 硬件产品需求文档(PRD)是智能硬件产品开发过程中不可或缺的一份重要文档,它详细描述了产品的功能、性能、规格参数、业务流程等方面的要求。下面,我们将详细介绍如何编写...

    程序员项目交接文档

    程序员项目交接文档概要 IT 项目交接文档概要是程序员在项目交接过程中的重要文件,它对项目的开发、测试和维护起着至关重要的作用。本文档概要将对程序员项目交接文档的主要内容进行概要介绍。 人事模块是程序员...

    软件开发时必写的几个文档

    以下是一些软件开发中必写的文档及其重要性: 1. **项目需求文档 (PRD)**:项目需求文档详细列出了软件应实现的功能、性能和用户体验要求。它通常包括目标用户群体、产品愿景、功能需求和非功能需求(如性能、安全...

    国家标准软件开发文档模板————可以帮助一些不喜欢些项目文档的或者是不知道怎么写文档的朋友解决很大的问题!~试试看

    国家标准软件开发文档模板是指导软件开发过程中的重要参考资料,它为开发者、项目经理和团队成员提供了规范化的写作框架,确保了项目...通过这种方式,即使是不擅长编写文档的人也能快速上手,提高整个团队的工作效率。

    vb开发的读写word文档

    在VB(Visual Basic)开发中,读写Word文档是一项常见的任务,这主要涉及到Microsoft Office的自动化接口,也称为COM(Component Object Model)自动化。通过这个接口,VB程序能够控制Word应用程序,实现创建、编辑...

    QT 帮写软件帮助文档

    在“QT 帮写软件帮助文档”项目中,很可能就是利用Qt Assistant来构建和组织与QT相关的各种开发指南和API信息。 编写QT帮助文档通常涉及以下几个关键知识点: 1. **Qt Creator**:这是QT的主要集成开发环境(IDE)...

    如何写技术文档.pdf

    这是作者写的一份如果进行技术文档和架构设计的一份演讲稿PPT。里面详细介绍了一个架构文档中最常用到的7种UML图形以及每种图形的作用,何时该用对应的UML表达一个清晰的架构设计。最后ppt最后总结了一个架构规划的...

Global site tag (gtag.js) - Google Analytics