mcpField
D
documentation

documentation

github.com/thebeardedbearsasDevelopment108144 installsUpdated 4d ago
Repository

About documentation

A skill with guidelines for writing project documentation, aimed at developers who need consistent documentation practices. It covers README files, changelogs, architecture decision records, code comments, and API specifications, with a separate reference for details.

Key features

  1. 01README content guidance
  2. 02Changelog format guidance
  3. 03Architecture decision record guidance
  4. 04Code comment principles
  5. 05API specification guidance

Use cases

  1. 01Write a project README
  2. 02Maintain a structured changelog
  3. 03Record major architecture decisions
  4. 04Improve API specifications

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/thebeardedbearsas/claude-craft --skill documentation

After installing, type/documentationin Claude Code to confirm it loaded.

Bundled filesREFERENCE.md

Details

From the project README

Documentation

This skill provides documentation guidelines and standards.

See @REFERENCE.md for detailed documentation.

Quick Reference

  • README: Installation, quick start, config, commands
  • CHANGELOG: Keep a Changelog format
  • ADR: Architecture Decision Records for major choices
  • Code: Comments explain WHY, not WHAT
  • API: OpenAPI/Swagger specs

Comments

Markdown supported