docs-applying-content-quality

This skill acts as a comprehensive quality assurance framework for all markdown-based communication within the Open Sharia Enterprise repository. It enforces a professional tone and consistent structural integrity, ensuring that documentation across docs/, web sites, and project plans remains readable, accessible, and maintainable. By mandating active voice and specific heading nesting rules, it eliminates ambiguity and improves information retrieval for developers and stakeholders.

• Enforces singular H1 usage and strict hierarchical heading nesting to ensure logical document flow.

• Validates accessibility compliance, specifically requiring descriptive alt text for images and ensuring WCAG AA color contrast ratios.

• Implements content constraints such as paragraph length limits (≤5 lines) and mandatory language specification in code blocks for proper syntax highlighting.

• Prohibits time-based framing (e.g., 'this takes 5 minutes') to prevent artificial pressure and ensure content remains universally applicable regardless of user experience.

• Standardizes formatting, including bold for emphasis over italics and the use of semantic lists, to optimize screen reader compatibility.

• Automates quality checks for repository root files like README.md and CONTRIBUTING.md, promoting professional project presentation.

• Provides a reusable checklist for manual or automated verification to ensure that every markdown file adheres to high-quality engineering documentation standards.

• Integrate this skill into your workflow when authoring or reviewing technical documentation, tutorial content, or project plans.

• Ensure all diagrams and images included in the repository meet the defined alt-text and accessibility guidelines.

• Use this skill to audit legacy content and bring it up to current repository standards before publishing or major updates.

• Keep paragraphs concise and jargon-free, utilizing the provided principles to ensure content is accessible to readers with varying levels of technical expertise.