aod-docs-and-writing

Manage Area Occupancy Detection project documentation with Markdown formatting and style guidelines.

316|9|Updated Nov 23, 2024
One-click install
npx skills add https://github.com/Hankanman/Area-Occupancy-Detection --skill aod-docs-and-writing
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: aod-docs-and-writing
Source: https://github.com/Hankanman/Area-Occupancy-Detection/tree/main/.claude/skills/aod-docs-and-writing
Command: npx skills add https://github.com/Hankanman/Area-Occupancy-Detection --skill aod-docs-and-writing

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill helps streamline the documentation and writing process for the Area Occupancy Detection project, ensuring consistency and quality across various documentation types.

Core Features & Use Cases

  • Documentation Management: Provides guidelines for writing and maintaining documentation for the Area Occupancy Detection project.
  • Style Conventions: Defines house style for documentation, including Markdown syntax, tables, and diagrams.
  • Quick Start: Offers a simple command to update documentation, such as "update the docs" or "add a features page".

Quick Start

Use the aod-docs-and-writing skill to update the documentation for a new feature in the Area Occupancy Detection project.

Frequently Asked Questions about aod-docs-and-writing

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write consistent Markdown documentation for a code project?

To write consistent Markdown documentation, apply standardized style conventions for syntax, tables, and diagrams to ensure uniform structure across README files and docstrings. This process enforces specific formatting rules to maintain project documentation quality and readability.

What style guidelines should I follow for code documentation and docstrings?

Style guidelines for code documentation and docstrings require adherence to specified house style conventions covering Markdown syntax, content structure, and formatting. Following these defined rules ensures your project documentation maintains consistency and quality across all written materials.

How do I structure a README file for an Area Occupancy Detection project?

Structuring a README file for an Area Occupancy Detection project involves applying predefined documentation management guidelines to organize content, features, and Markdown formatting. This approach ensures the resulting documentation follows established house style and content structure conventions.

Can I use standard Markdown formatting for tables and diagrams in project documentation?

Standard Markdown formatting for tables and diagrams is supported when it aligns with the defined house style conventions. The documentation management process specifies exact syntax and formatting rules to ensure tables and diagrams maintain consistency across the project.

What is the best way to update project documentation when adding a new feature?

The best way to update project documentation when adding a new feature is to apply the established style conventions to the new content. This documentation management process ensures new feature descriptions integrate seamlessly with existing Markdown formatting and content structure guidelines.

When should I not use automated documentation style guidelines?

You should not use automated documentation style guidelines when writing content that falls outside the scope of project documentation, README files, or docstrings. These style conventions are specifically tailored for the Area Occupancy Detection project and may not apply to external documentation formats.