docs-doc-principle
Community统一文档写作与结构规范,避免页面失效
Content & Communication#developer experience#i18n#mdx#documentation standards#bilingual writing#demo governance#routing integrity
AuthorPionpill
Version1.0.0
Installs0
System Documentation
What problem does it solve?
解决 retikz 文档站在内容、注册数据与 i18n 三处不同步导致 404、菜单与标题错乱、以及页面结构不一致导致阅读体验差的问题。
Core Features & Use Cases
- 三处协同约束:确保内容(contents/)、注册(data/)、文案(i18n/)严格同步,避免页面无法路由或侧栏不显示。
- 双语与写作风格统一:中文为源语言、英文跟随;规定标题与术语风格、精简写作、读者视角与层级组织。
- DSL/演示与对照规范:以 DSL 为主、IR 克制;演示与对照必须走对应组件与规则,图示必须使用 retikz 自绘,且位置/关系类 demo 有专门写法。
Quick Start
让 AI 在你新增或改动任意 docs 页时,先依据本 skill 的规则检查三处协同目录、双语 i18n key、页面类型分流与演示图示约束,最后再给出可直接落地的 mdx 与 data/i18n 修改建议。
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: docs-doc-principle Download link: https://github.com/Pionpill/retikz/archive/main.zip#docs-doc-principle Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.