如何设计和使用文档模板 | 技术写作什么鬼

今天看到叶伟民老师的一篇文章,瞬间泪目:叶老师,您是懂人性的啊。在我整天鞭策自己“不能再拖了”的关键时刻,及时分享经验:

6d025ca8c6fa9f50bf371897fcbcc5e8.png

是的,这篇文章实在是拖了太久,了太久,太久,久……

书接:从0到1的模板插件 | Obsidian实践,有朋友提问说:你有现成的模板,可以分享一下吗?

针对这个提问,第一时间便起草文章,不过写着写着思路散了,便被搁置一边,拖延至今也没有完成……

所以,必须下定决心,花点时间理清思路,把这篇文章继续写完吧。


话说,Obsidian实践,属于个人知识管理的场景。个性化的经验,就很难被其他人直接复用。如果我们把场景,从个人知识管理,切换到日常工作中,信息场景往往会更加聚焦和典型。比如说,产品立场最常进行需求说明;研发立场主要关注概要设计;测试立场也少不了输出测试方案……那么在这种情况下,就比较容易总结、归纳既往经验,形成模板进行复用。

所以我们换个思路,聊聊如何在工作场景中,定义和使用模板。

为什么使用模板?

不过,在切入正题之前,还是想先形而上学地整点儿所谓的“意义”。是因为,

对于使用模板,可能存在一个比较普遍的错误认识:使用模板是应付写作任务的生搬硬套。

所以很多时候我们会发现出现这样的情况,即便是基于成熟的内容模板写作,最终输出的内容质量依然不太令人满意:对模板章节点内容理解错误;上下文缺乏逻辑关联;或者内容不连贯,不自洽的情况。以至于,原本我们希望通过写作梳理和阐述的问题逻辑,依然没能得到很好的体现。

我们通常会认为,模板是对内容和格式的复用。其实这还只是一个方面,更重要的是,模板本质上的体现的是典型的信息场景,其内容是对当前场景的经验和思路的积累和复用,以便高效沟通和解决问题

所以,无论是设计模板,还是使用模板,都需要聚焦在对问题逻辑的阐述上,才可以更好地发挥模板的作用。

如何设计模板?

设计模板的基本思路是:

  • 明确面向对象;明确信息目标。

  • 基于已有经验,梳理解决问题的思路;

  • 调研信息需求,使思考更加全面充分;

  • 结合上述两者,输出内容架构和写作说明。

首先,明确面向对象和信息目标,对于文档开发而言,是非常重要的。这一定程度上可以看作是“产品思维”的体现,在模板设计阶段,就尽可能聚焦于,典型信息场景要解决的具体问题。

接下来,我们基于已有经验,把当前场景中思考和解决问题的逻辑梳理清楚,这实际上也是对知识、经验进行总结和积累的过程。

为了便于与人沟通我们的想法,还可以通过信息调研、文档评审,或者日常沟通,收集多方的反馈和建议,不断充实完善我们的逻辑叙述。

当我们很好地梳理了自己的思考逻辑,并且充分了解了相关干系人的信息需求,然后通过内容架构和写作说明地方式,将这些内容记录下来,便形成了可被复用的模板。

如何使用模板?

使用模板的基本思路基本相同:

  • 理解目标对象;理解信息目标。

  • 理解模板内容架构;理解阐述问题的基本逻辑。    

  • 基于模板,结合实际场景和问题,有取舍地写作。  

当我们使用模板进行文档开发时,首先,要沉下心来搞清楚,当前信息场景的面向对象和信息目标——这是我们之所以写作文档的根本动机,是为了高效沟通和解决一个非常具体的问题,并不是“为写而写”。

然后,通过模板的内容架构和写作说明,理解阐述问题的逻辑,以及相关人员的信息需求。而且你有没有想过,如果你是一个职场新人,通过模板继承前辈的工作经验,尤其是思考逻辑,这也是非常好的学习过程。

写作时,不要一味地生搬硬套,有的没的都要硬拽上两句,而是要结合自己要阐述的具体问题,有选择地写作相关内容;也不要东拼西凑,差不多的就往里填,而是要注意行文的逻辑延续,前后文的内容自洽。  

如此才能真正达成写作一份文档的目的:高效沟通和解决问题。如果费半天劲写出的文档无法满足信息目标,真就只能是:瞎子点灯——白费啦(蜡)。

关于模板前言

有朋友问说,我们就想就事论事,把文档写得简洁明快一些,不想附加太多不必要的内容,所以前言的部分可不可以去掉?

个人并不建议这样做,因为前言部分就像是文档的“元(meta)信息”,是用来介绍文档基本情况的信息,主要包括:

  • 面向对象,包括需要具备的知识和能力;

  • 信息目标,即文档的使用场景和主要内容;

  • 规范约定,包括但不限于常用符号、数字单位的写法和含义;版本号的定义等;

  • 修订记录,即文档历史和主要变更。

前言的作用可大了:

  • 帮助写作者明确文档的场景定位和信息目标,以及了解基本写作规范;

  • 帮助读者了解文档主要内容,阅读文档需要具备的知识和能力,以及文档内容变更等。

其实,前言中很多内容,可以在制作模板时一次性写好,后续写作时,只需要考虑“是否涉及”,判断取舍就可以,并不需要重复写作。

总结

当我们谈“模板”时,你以为我们在谈“文档”吗?不,我们实际关注的是:思维逻辑、知识积累和高效沟通。

今天的分享就是这些内容。希望你可以从此善用模板,通过设计模板积累知识和经验,通过使用模板学习和成长。

相关文章:#技术文档什么鬼

其他推荐:

实施:GitHub + MarkDown 文档系统的工作环境部署及工作流程说明 | 技术传播

4cee8cb40dff80d96d71747712d22b0d.jpeg

技术传播是一片蓝海 | 技术传播

访谈:TC无处不在,只是我们没有发觉 | 技术传播

这次他们说好要“讲真的” | 传播

在座都别吵了,你们还有我 | 技术传播

一本培养强迫症患者的说明书 | 技术传播

就像用心做好日本料理 | 技术传播

顽固的老头子与无聊的说明书 | 技术传播

转战新媒体 | 技术传播

评测:王者荣耀的用户帮助系统 | 技术传播

让爸爸妈妈也能享受到科技发展带来的便利 | 技术传播

企业级信息管理系统初创方案构思 | 技术传播

 c7cd59a860fcc49be48c32fda1c7ca27.png

睿齐

技术传播从业者

品牌内容策划

自由摄影师

自由撰稿人

汪力迪

公众号:techcomm / htstory

微信号:bgrichi

邮箱:hash_0813@163.com

4291427d556eac2d194e76af502ef188.jpeg

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
C语言是一种广泛使用的编程语言,它具有高效、灵活、可移植性强等特点,被广泛应用于操作系统、嵌入式系统、数据库、编译器等领域的开发。C语言的基本语法包括变量、数据类型、运算符、控制结构(如if语句、循环语句等)、函数、指针等。在编写C程序时,需要注意变量的声明和定义、指针的使用、内存的分配与释放等问题。C语言中常用的数据结构包括: 1. 数组:一种存储同类型数据的结构,可以进行索引访问和修改。 2. 链表:一种存储不同类型数据的结构,每个节点包含数据和指向下一个节点的指针。 3. 栈:一种后进先出(LIFO)的数据结构,可以通过压入(push)和弹出(pop)操作进行数据的存储和取出。 4. 队列:一种先进先出(FIFO)的数据结构,可以通过入队(enqueue)和出队(dequeue)操作进行数据的存储和取出。 5. 树:一种存储具有父子关系的数据结构,可以通过中序遍历、前序遍历和后序遍历等方式进行数据的访问和修改。 6. 图:一种存储具有节点和边关系的数据结构,可以通过广度优先搜索、深度优先搜索等方式进行数据的访问和修改。 这些数据结构在C语言中都有相应的实现方式,可以应用于各种不同的场景。C语言中的各种数据结构都有其优缺点,下面列举一些常见的数据结构的优缺点: 数组: 优点:访问和修改元素的速度非常快,适用于需要频繁读取和修改数据的场合。 缺点:数组的长度是固定的,不适合存储大小不固定的动态数据,另外数组在内存中是连续分配的,当数组较大时可能会导致内存碎片化。 链表: 优点:可以方便地插入和删除元素,适用于需要频繁插入和删除数据的场合。 缺点:访问和修改元素的速度相对较慢,因为需要遍历链表找到指定的节点。 栈: 优点:后进先出(LIFO)的特性使得栈在处理递归和括号匹配等问题时非常方便。 缺点:栈的空间有限,当数据量较大时可能会导致栈溢出。 队列: 优点:先进先出(FIFO)的特性使得
Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),可运行高分资源 Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现的毕业设计&&课程设计(包含运行文档+数据库+前后端代码),Java实现
C语言是一种广泛使用的编程语言,它具有高效、灵活、可移植性强等特点,被广泛应用于操作系统、嵌入式系统、数据库、编译器等领域的开发。C语言的基本语法包括变量、数据类型、运算符、控制结构(如if语句、循环语句等)、函数、指针等。在编写C程序时,需要注意变量的声明和定义、指针的使用、内存的分配与释放等问题。C语言中常用的数据结构包括: 1. 数组:一种存储同类型数据的结构,可以进行索引访问和修改。 2. 链表:一种存储不同类型数据的结构,每个节点包含数据和指向下一个节点的指针。 3. 栈:一种后进先出(LIFO)的数据结构,可以通过压入(push)和弹出(pop)操作进行数据的存储和取出。 4. 队列:一种先进先出(FIFO)的数据结构,可以通过入队(enqueue)和出队(dequeue)操作进行数据的存储和取出。 5. 树:一种存储具有父子关系的数据结构,可以通过中序遍历、前序遍历和后序遍历等方式进行数据的访问和修改。 6. 图:一种存储具有节点和边关系的数据结构,可以通过广度优先搜索、深度优先搜索等方式进行数据的访问和修改。 这些数据结构在C语言中都有相应的实现方式,可以应用于各种不同的场景。C语言中的各种数据结构都有其优缺点,下面列举一些常见的数据结构的优缺点: 数组: 优点:访问和修改元素的速度非常快,适用于需要频繁读取和修改数据的场合。 缺点:数组的长度是固定的,不适合存储大小不固定的动态数据,另外数组在内存中是连续分配的,当数组较大时可能会导致内存碎片化。 链表: 优点:可以方便地插入和删除元素,适用于需要频繁插入和删除数据的场合。 缺点:访问和修改元素的速度相对较慢,因为需要遍历链表找到指定的节点。 栈: 优点:后进先出(LIFO)的特性使得栈在处理递归和括号匹配等问题时非常方便。 缺点:栈的空间有限,当数据量较大时可能会导致栈溢出。 队列: 优点:先进先出(FIFO)的特性使得
提供的源码资源涵盖了安卓应用、小程序、Python应用和Java应用等多个领域,每个领域都包含了丰富的实例和项目。这些源码都是基于各自平台的最新技术和标准编写,确保了在对应环境下能够无缝运行。同时,源码中配备了详细的注释和文档,帮助用户快速理解代码结构和实现逻辑。 适用人群: 这些源码资源特别适合大学生群体。无论你是计算机相关专业的学生,还是对其他领域编程感兴趣的学生,这些资源都能为你提供宝贵的学习和实践机会。通过学习和运行这些源码,你可以掌握各平台开发的基础知识,提升编程能力和项目实战经验。 使用场景及目标: 在学习阶段,你可以利用这些源码资源进行课程实践、课外项目或毕业设计。通过分析和运行源码,你将深入了解各平台开发的技术细节和最佳实践,逐步培养起自己的项目开发和问题解决能力。此外,在求职或创业过程中,具备跨平台开发能力的大学生将更具竞争力。 其他说明: 为了确保源码资源的可运行性和易用性,特别注意了以下几点:首先,每份源码都提供了详细的运行环境和依赖说明,确保用户能够轻松搭建起开发环境;其次,源码中的注释和文档都非常完善,方便用户快速上手和理解代码;最后,我会定期更新这些源码资源,以适应各平台技术的最新发展和市场需求。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值