关于 evergreen-technical-book
这项技能帮助作者规划和修订技术书籍,使核心内容在工具与厂商细节变化时仍然实用。它指导区分长期有效的概念与易过时内容,并维护配套资源。
主要功能
- 01按内容变化速度分类
- 02区分书籍内容与配套资源
- 03规划配套资源的负责人和更新
- 04制定维护机制与审查政策
适用场景
- 01规划经久实用的技术书籍
- 02修订工具细节过多的草稿
- 03为示例和参考资料制定更新政策
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ lvtd-llc/ skills --skill evergreen-technical-book安装后在 Claude Code 中输入/evergreen-technical-book确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
agents/openai.yamlreferences/core/checklist.mdexamples.mdknowledge.mdrules.mdworkflows/split-book-and-companion.md详细介绍
常青技术书籍
核心视角
当印刷版或稳定稿件传授的是长期有效的原则、决策框架、心智模型和工作流,而易变的命令、界面操作指南、供应商详情和特定版本的步骤则放在可更新的配套资源中时,技术书籍才能历久弥新。
使用此技能来:
- 决定哪些内容适合放在技术书籍中,哪些更适合放在网站、代码仓库、练习表、视频或检查清单中。
- 减少版本偏移,同时避免让书籍变得抽象。
- 为配套资源设计更新政策。
- 让自托管、DevOps、软件或基础设施类书籍在多年后依然有用。
- 修改堆砌了过多工具细节的草稿。
参考资料索引
| 需求 | 阅读 |
|---|---|
| 常青概念和术语 | references/core/knowledge.md |
| 持久性和拆分规则 | references/core/rules.md |
| 书籍与配套资源示例 | references/core/examples.md |
| 快速持久性检查清单 | references/core/checklist.md |
| 拆分书籍和配套资源 | workflows/split-book-and-companion.md |
工作流
1. 明确持久价值
说明读者应获得什么成果,以及这一成果如何在数年内持续具有价值。
如果这一承诺依赖某个供应商、某个界面或某个特定工具版本,请决定这本书是否有意按版本出版,还是应该重新定位。
2. 按半衰期分类内容
为每个主要章节或资料标记类别:
- 持久:概念、权衡、故障模式、原则、心智模型。
- 半持久:工作流、架构模式、检查清单、示例配置。
- 易变:界面点击操作、价格、供应商政策、确切的软件包版本、屏幕截图、短期工具。
3. 拆分内容
保持书籍内容具体,但如果易变细节会让稿件很快过时,就将这些内容移至配套资源中。
即使没有升级销售、隐藏资源或易失效的链接,书籍也应能兑现其核心承诺。
4. 设计配套资源
为每项配套资源明确:
- 用途。
- 负责人。
- 更新触发条件。
- 稳定的 URL 或代码仓库路径。
- 版本或上次审核说明。
- 书籍如何引用该资源,并确保资源变更时引用不会失效。
5. 添加更新机制
制定维护计划:
- 按版本管理的示例。
- 变更日志或上次审核日期。
- 供读者提交问题或报告的途径。
- 定期审核安排。
- 淘汰过时工具的政策。
输出格式
帮助编写常青技术书籍时,请返回:
- 持久性诊断。
- 书籍与配套资源拆分表。
- 建议删减或迁移的范围。
- 配套资源计划。
- 更新政策和审核安排。
- 针对易变内容的稿件表述。
质量标准
不要通过让书籍变得含糊来解决内容偏移问题。让读者的学习路径保持具体,同时确保易变细节易于更新,过时后也容易跳过。
评论
支持 Markdown