doc-standard

Installation
SKILL.md

文档写作规范

本规范约束 youlai-admin-docs 所有栏目的写作风格。目标:让读者快速找到代码、复制即用,不读废话。

核心原则

读者带任务来,带代码走。 文档存在的唯一价值是让读者尽快完成手头的事,而不是展示作者的知识体系。

代码给机器执行,文档给人理解。写文档时先想:读者为什么打开这页?他要走的时候手里该拿着什么?

文档分类框架

基于 Diátaxis 框架,文档按读者需求分四种模式。一篇文档只做一件事,混合模式是质量下降的开始。

Installs
9
GitHub Stars
55
First Seen
Aug 22, 2026
doc-standard — youlaitech/youlai-skills