walkeros-writing-documentation

Standardize documentation by enforcing a consistent structure for package READMEs, website docs, and skills. This ensures quality standards and DRY patterns are applied uniformly across all walkerOS documentation outputs.

Writing skill descriptions requires YAML frontmatter with name and description fields, followed by a three-section description structure. This format ensures alignment with validation guidelines for clarity and consistency.

Validate documentation examples by applying standardized validation guidelines described in the skill. This process enforces DRY patterns and ensures example accuracy across package READMEs and website docs.

AI assistants can update website docs and READMEs consistently by adhering to the standardized documentation skill. This supports a collaborative workflow for contributors and engineers maintaining documentation quality.

Maintain documentation consistency across a monorepo by standardizing how READMEs, website docs, and skills are written. Applying uniform validation guidelines and DRY patterns prevents fragmented documentation across packages.