- 文档结构:
- 使用H2标题组织主要章节
- 每个Markdown文件不超过2000字(约5分钟阅读量)
- 长文档必须包含目录(TOC)
- 内容规范:
- 每章节开头提供简要概述
- 技术概念首次出现时需明确定义
- 配置示例必须包含完整Yaml和注释
- 格式要求:
- 使用Mermaid/PlantUML生成架构图
- 重要警告使用> [!WARNING]语法突出
- 代码块标注语言类型和适用环境
- 版本管理:
- 文档头部包含最后更新时间
- 重大变更记录在CHANGELOG中
- 废弃内容标注替代方案
Kubernetes Mkdocs Documentation Documentation Best Practices Rules
Kubernetes文档编写规范,确保技术文档的可读性和可维护性
Kubernetes Mkdocs Documentation Documentation Best Practices Rules by liaosw97 · db8075c
npx skillmds@latest add liaosw97/kubernetes-mkdocs-documentation-documentation-best-practices File contents
---name: kubernetes-mkdocs-documentation-documentation-best-practicesdescription: Kubernetes文档编写规范,确保技术文档的可读性和可维护性---- **文档结构**: - 使用H2标题组织主要章节 - 每个Markdown文件不超过2000字(约5分钟阅读量) - 长文档必须包含目录(TOC)- **内容规范**: - 每章节开头提供简要概述 - 技术概念首次出现时需明确定义 - 配置示例必须包含完整Yaml和注释- **格式要求**: - 使用Mermaid/PlantUML生成架构图 - 重要警告使用> [!WARNING]语法突出 - 代码块标注语言类型和适用环境- **版本管理**: - 文档头部包含最后更新时间 - 重大变更记录在CHANGELOG中 - 废弃内容标注替代方案
liaosw97/awesome-rules-skills/tree/main/plugins/kubernetes/skills/kubernetes-mkdocs-documentation-documentation-best-practices-rules commit db8075c604
Frequently asked questions
Run npx skillmds@latest add liaosw97/kubernetes-mkdocs-documentation-documentation-best-practices in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.
Kubernetes文档编写规范,确保技术文档的可读性和可维护性 It is listed under DevOps & Infra on SkillMD.
This skill has not completed SkillMD's automated safety review yet. Capability flags: docs only. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.
This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.
Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.
liaosw97 (@liaosw97) published this skill. Their other Agent Skills are listed on their SkillMD profile.