跳到主内容
简牍jiandu
阅读模式

模板:从已有文章提炼模板与方法论

官方template方法论masonv1
查看历史版本
目录

产出一:模板

正文骨架照这个形状写。元数据注释里的 name 用类型的英文短名(postmortemdesign…),description 要带触发词——agent 靠它决定要不要用这份模板:

# <类型>:{{标题变量}}

<!-- jiandu-template
name: <英文短名>
description: <一句话说清什么场景用>。触发:<3–5 个触发词>
arguments: <变量名>(说明); <可选变量>?(说明)
-->

<!-- 第一段一句话说清结论,会截成列表页摘要 -->

## <必填节 1>

<!-- 这一节填什么、填到什么程度、什么情况下写「无」 -->

## <必填节 2>

## <可选节>

<!-- 什么情况下需要这一节;不需要就整节删掉 -->

每节都要配一句注释说清「填什么、填到什么程度」。没有注释的空标题等于没有模板——agent 和人都会各写各的。

产出二:方法论

模板管住了结构,方法论管住了判断。骨架:

# <类型>怎么写

<!-- 一句话:这类文档是给谁看的、读者看完要能做什么决定 -->

## 读者与目的

<!-- 谁读、读完做什么决定。这一节决定后面所有取舍 -->

## 每节写什么

<!-- 逐节说明判断标准,而不是重复模板里的标题。例:
     「影响面」要写清受影响的用户量级和时间窗,写不出量级就说明还没查清楚,不要用「部分用户」蒙过去 -->

## 常见问题

<!-- 从样本里真实观察到的问题,一条一个,带「反例 → 改法」。不要写放之四海皆准的废话 -->

## 样本

<!-- 提炼自哪几篇,带链接。让人能核对结论、也能看到好例子 -->

「常见问题」一节的每条都要能追溯到某篇样本里的真实写法,写不出反例的条目删掉。

为什么这样提炼

  • 从已经写过的东西反推,比从零设计模板准:真实文章里反复出现的节才是真需求,想象出来的「完备结构」多半有一半没人填
  • 模板和方法论分开:模板是填空题,越短越好用;方法论是判断标准,可以长。混在一起会让模板变成一篇没人愿意打开的说明书
  • 样本要列出来:读者不同意你的归并方式时,能自己去看原文。三篇以下的提炼结论不可靠,要标出来