メニュー
User-documentation writing standards. Use this skill when writing or reviewing docs under docs/. Covers directory structure, writing style, page templates, internationalization, version management, and review checklist.
Codex または Claude でインストール この Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。
SOC 職業分類に基づく
| name | doc-standards |
| description | User-documentation writing standards. Use this skill when writing or reviewing docs under docs/. Covers directory structure, writing style, page templates, internationalization, version management, and review checklist. |
About this directory:
skills/11-doc/is the writing standard and style guide for authoring and reviewing the publicdocs/directory; it is itself not user-facing documentation and is not part ofdocs/. To browse user documentation, go todocs/; read this directory only to learn how to write good user documentation.
Applies to all human-facing documentation under
docs/.skills/targets AI and developers and is not bound by these rules.
en/ and zh-CN/ keep fully consistent directory and file structuredocs/ does not cover internal implementation; link to dev-guide or external docs when needed| # | File | Topic |
|---|---|---|
| 00 | 00-doc-structure.md | Documentation directory structure: four-layer system, directory naming, README.md conventions, VitePress navigation sync, placement decisions for new documents |
| 01 | 01-writing-style.md | Writing style + YAML examples + cross-references: heading rules, person and tone, Edgion-extension callouts, YAML completeness and placeholders, link conventions |
| 02 | 02-page-template.md | Page templates + parameter tables + FAQ conventions: section structure for plugin pages, Route pages, ops pages, Getting Started pages; four-column parameter-table format; FAQ Q/A format |
| 03 | 03-i18n-rules.md | Internationalization: en/zh-CN symmetry rules, source-language convention, glossary, sync workflow, Chinese typography |
| 04 | 04-versioning-and-changelog.md | Document version management: change-trigger rules, Breaking Change callouts, deprecation callouts, relationship with Release Notes |
| 05 | 05-review-checklist.md | Documentation review checklist: technical accuracy, completeness, multilingual sync, link validity, security review |
| You want to… | Entry point |
|---|---|
| Write a documentation page for a new plugin | 02-page-template.md §Plugin page template |
| Decide which directory a new document goes in | 00-doc-structure.md §Placement decision tree |
| Write YAML examples | 01-writing-style.md §YAML example conventions |
| Handle bilingual content when adding a document | 03-i18n-rules.md §Sync workflow |
| Review documentation written by others | 05-review-checklist.md |
| Write a configuration parameter table | 02-page-template.md §Configuration parameter table conventions |
Conventions shared by the in-repo binaries (edgion-controller, edgion-gateway, edgion-cli) — project overview, command line / directory / config-path conventions, Core layering conventions, resource system.
KubernetesCenter implementation — K8s Reflector watching, leader election, HA mode, ResourceController lifecycle, status writeback.
ConfigCenter subsystem — ConfCenter trait abstraction, FileSystemCenter and KubernetesCenter implementations, unified Workqueue + ResourceProcessor pipeline.
edgion-controller control plane architecture — overall design, startup/shutdown, Admin API, ConfigCenter, Workqueue, ResourceProcessor, Requeue, CacheServer, ACME service.
Route matching overview — multi-stage pipeline (Listener→Domain→Path→DeepMatch), per-listener isolation, registration flow, atomic swap.
TLS subsystem overview — TLS Store, SNI matching, certificate management, BoringSSL/OpenSSL backend selection.