documentation-guidelines

Plugin documentation-guidelines from marketplace violet-plugin-place in joySUSY/violet-plugin-place. Commands read from the repo's manifest — 1 month ago.

Skills (7)

• documentation-guidelines

  Master engineer's guide to writing documentation, architecture diagrams, APIs, and cross-team communication (PRs, Handoffs). Use when generating READMEs, API specifications (OpenAPI/Swagger), structuring internal proposals (RFCs), writing docstrings, explaining codebase architecture, or creating cle

• code-comment-improver

  Use when improving code comments, adding documentation, or reviewing comment quality. Helps write clear, useful comments that explain why, not just what.

• code-comments

  Extract comment locations from code files for analysis. Use when cleaning comments, auditing code documentation, or analyzing comment patterns. Supports Python, JavaScript, TypeScript, Go, Rust, Java, C/C++, Ruby, PHP, Shell scripts. Trigger terms - comments, extract comments, code comments, comment

• design-md

  Use this skill when the user wants to analyze a Stitch project and create a reusable DESIGN.md design system file with semantic style tokens and prompting guidance.

• effective-commenting-strategies

  Use this skill when writing, reviewing, or maintaining code comments. Apply these strategies to ensure comments explain intent rather than repeat code, use maintainable styles, and follow density guidelines. This skill covers comment types, style best practices, and performance considerations.

• effective-commenting

  Best practices for writing meaningful and clean code comments.

• schema-markup

  When the user wants to add, fix, or optimize schema markup and structured data on their site. Also use when the user mentions "schema markup," "structured data," "JSON-LD," "rich snippets," "schema.org," "FAQ schema," "product schema," "review schema," "breadcrumb schema," "Google rich results," "kn

Slash commands (1)

• /documentation-guidelines:prime:doc-foundations

  Prime the documentation engine — load writing standards, BLUF principle, and bilingual strategy before writing any formal document.

Subagents (1)

• calliope

  Documentation Mind specializing in technical writing, API docs, bilingual document production, and semantic linking. Use when writing formal specs, READMEs, handoff notes, or dual-language documentation.

Similar plugins