Files
Endorphin-Document/authoring/templates/README.md

19 lines
1.2 KiB
Markdown

# 页面模板
模板用于确定信息职责,不要求机械填满所有栏目。删去不适用的栏目,并保留真正影响合法性与理解的条件。
| 编号 | 模板 | 适用目的 |
| --- | --- | --- |
| TPL-01 | [概念指南](TPL-01.md) | 逐步建立一个概念及其基本用法 |
| TPL-02 | [任务指南](TPL-02.md) | 已有前提下完成一个明确操作 |
| TPL-03 | [语法或 API 参考](TPL-03.md) | 查询形式、参数、约束和效果 |
| TPL-04 | [概念解释与比较](TPL-04.md) | 理解关系、设计理由或替代方案 |
| TPL-05 | [变更工作单](TPL-05.md) | 记录较大修改的依据、影响与验证,不属于读者正文 |
| TPL-06 | [审查报告](TPL-06.md) | 交付有证据、可实施的问题与建议 |
模板借鉴 [Diátaxis 的职责区分](../research/SRC-14.md),是本项目的页面组织建议。概念指南可以结合少量讲解与示例;尚无执行环境时不将它包装成可运行教程。
模板代码块里的文字是写作占位,不是文件名、真实链接或 Endorphin 源码。实际正文必须替换占位内容,并通过[检查清单](../checklist.md)。
[手册入口](../README.md)