Back to list
bash0C7

documentation-standards

by bash0C7

[WIP]Development Kit for PicoRuby Application running on R2P2-ESP32 with ESP32 Microcontroller Device

1🍴 0📅 Dec 30, 2025

SKILL.md


name: Documentation Standards description: Provides guidelines for maintaining and updating documentation alongside code changes. Use this when implementing features, fixing bugs, or changing APIs that affect user-facing documentation.

Documentation Standards Skill

This skill guides AI agents on how to maintain and update documentation when making code changes.

When to Use This Skill

Use this skill when:

  • You're implementing a new feature and need to know which docs to update
  • You're fixing a bug that affects user-facing behavior
  • You're changing command APIs or signatures
  • You're creating new templates or workflows
  • You need clarity on documentation standards and structure

Key Principles

  1. Documentation is Part of the Feature — Update docs in the same commit as code changes
  2. No Historical Context — Keep all .md files clean, forward-facing only
  3. Specification Firstdocs/SPECIFICATION.md is the source of truth
  4. Clear Audience Separation — User-facing vs. developer-facing sections
  5. Link Consistency — All references point to current locations

Files Maintained by This Skill

  • docs/SPECIFICATION.md — Command specifications and behavior
  • docs/CI_CD_GUIDE.md — User/developer CI/CD workflows
  • docs/MRBGEMS_GUIDE.md — mrbgem development and usage
  • docs/DEVICE_TESTING_GUIDE.md — Device testing procedures
  • docs/PROJECT_INITIALIZATION_GUIDE.md — Project setup guide
  • README.md — Quick start and overview
  • AGENTS.md — This skill's documentation location

Implementation Guide

See update-guide.md in this directory for the step-by-step implementation checklist.

Score

Total Score

70/100

Based on repository quality metrics

SKILL.md

SKILL.mdファイルが含まれている

+20
LICENSE

ライセンスが設定されている

+10
説明文

100文字以上の説明がある

+10
人気

GitHub Stars 100以上

0/15
最近の活動

3ヶ月以内に更新がある

0/10
フォーク

10回以上フォークされている

0/5
Issue管理

オープンIssueが50未満

+5
言語

プログラミング言語が設定されている

+5
タグ

1つ以上のタグが設定されている

0/5

Reviews

💬

Reviews coming soon