Documentation Language Parity

소개

This skill automates the maintenance of high-quality, polyglot documentation for complex software ecosystems. It ensures that every technical guide and API reference includes synchronized, functional code examples for Rust, Python, TypeScript, Ruby, Java, Go, and C#. By enforcing specific directory structures, MkDocs tabbed formatting, and language-specific docstring standards (such as Javadoc, JSDoc, and YARD), it guarantees that developers receive a consistent experience regardless of their preferred programming language.

주요 기능

• Enforcement of language-specific inline doc standards (Javadoc, JSDoc, YARD, XML)
• Cross-language API reference consistency and verification
• Strict public API documentation requirements and safety comment enforcement
• Automated MkDocs snippet integration using pymdownx.tabbed syntax
• 480 GitHub stars
• Seven-language code snippet synchronization and validation

사용 사례

• Standardizing inline documentation across large-scale multi-language repositories
• Maintaining synchronized 'Getting Started' guides for polyglot SDKs and APIs
• Automating the generation of tabbed code blocks for technical documentation sites