Guide documentation of OpenFirma code, docs, and contributor material.
npx skills add https://github.com/Firma-AI/openfirma --skill docs-guidelines-firma-ai
Please help me install this Agent Skill. Skill: docs-guidelines Source: https://github.com/Firma-AI/openfirma/tree/main/.skills/docs-guidelines Command: npx skills add https://github.com/Firma-AI/openfirma --skill docs-guidelines-firma-ai
This Skill provides comprehensive guidelines to ensure OpenFirma's documentation is clear, concise, and user-friendly, improving the developer experience and maintainability.
Follow the guidelines in the 'docs-guidelines' skill to write clear and consistent documentation for your OpenFirma project.
High-intent search queries and answers about installing and using this skill.
OpenFirma documentation guidelines direct you to write clear, concise code comments and docstrings that explain the why, constraints, and invariants from a task-oriented user perspective. This structured approach ensures contributor-facing material remains highly maintainable.
You structure OpenFirma documentation by following a specific placement model that directs where to document specific types of information, such as README text and docs-site pages, ensuring best accessibility and maintainability for developers. This structured approach ensures contributor-facing material remains highly maintainable.
You should update OpenFirma documentation when changes occur to major behavior, CLI, configuration, or public API. The documentation guidelines provide specific instructions for updating contributor-facing material to reflect these code modifications accurately.
Yes, the OpenFirma documentation guide covers standards for writing README text and docs-site pages. It offers a comprehensive set of standards for documenting code and contributor-facing material, ensuring all documentation is user-friendly and task-oriented.
The best way to document OpenFirma constraints and invariants is by adopting a task-oriented approach that focuses on the user's perspective. The guidelines emphasize documenting the why behind the code to improve clarity and maintainability for contributors.
C0ntr0lledCha0sAutomate project documentation structure and governance with configurable tooling.
brainbrewlabsGenerate JSDoc, docstrings, README files, and API references from JavaScript/TypeScript and Python codebases.
ianyimiEnforce global coding style guidelines across multi-language codebases.
Likas07Generate developer documentation including READMEs, API references, tutorials, and conceptual guides.
