skills.rest
Mithrandir21
Mithrandir21COMMUNITY
Explore all skills by this author →
WebsiteGitHub

document-patterns

Analyze codebases to create and update Markdown documentation of coding patterns and conventions.

Updated Jan 2, 2024
Search Tags:#code quality#architecture#documentation#patterns#conventions
One-click install
npx skills add https://github.com/Mithrandir21/game-deals-android-app --skill document-patterns-mithrandir21
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-patterns
Source: https://github.com/Mithrandir21/game-deals-android-app/tree/main/.claude/skills/document-patterns
Command: npx skills add https://github.com/Mithrandir21/game-deals-android-app --skill document-patterns-mithrandir21

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill helps teams document and understand their internal coding patterns, architectural conventions, and design idioms, ensuring consistency and clarity across projects.

Core Features & Use Cases

  • Survey and Document Patterns: Automatically analyze codebases to identify recurring patterns and conventions.
  • Maintain Living Guides: Generate and update detailed Markdown documents (docs/PATTERNS.md) and pattern-specific files for ongoing reference.
  • Use Case: A team wants to ensure adherence to architectural standards; they invoke /document-patterns to produce an up-to-date patterns guide for onboarding and code review.

Quick Start

Invoke the /document-patterns command to generate the patterns index and detailed pattern documentation for the codebase.

Frequently Asked Questions about document-patterns

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

FAQPage Schema
How do I document coding conventions and architectural patterns in my codebase?▼

You can document coding conventions by invoking a command to automatically analyze your codebase and generate a comprehensive Markdown patterns guide. This creates an index of recurring architectural decisions and stylistic conventions for ongoing reference.

What is the best way to maintain living documentation for codebase architecture?▼

Maintaining living documentation for codebase architecture involves generating and updating detailed Markdown files within your repository. This approach ensures your architectural standards and coding patterns reflect current codebase changes for onboarding and code review.

Can I automatically generate a patterns guide for engineering onboarding?▼

Yes, you can automatically generate a patterns guide for engineering onboarding by surveying the codebase to identify recurring design idioms. This produces an up-to-date patterns index and detailed documentation files.

How do architectural conventions get identified and cataloged from existing code?▼

Architectural conventions are identified and cataloged by analyzing the codebase to detect recurring patterns and design decisions. This process extracts stylistic conventions and structural idioms into structured pattern-specific files.

Does this approach require any specific dependencies to map out coding standards?▼

No specific dependencies are required to map out coding standards using this approach. It operates directly on your codebase structure to produce detailed Markdown documentation and a patterns index without external plugins.

Related Skills

Explore More Software Engineering Skills→
cliftonccliftonc
9

start

Identify architectural layers and structure of an unfamiliar codebase.

Community
Intermediate
Camilo8902Camilo8902

dev-onboarding-builder

Generate developer onboarding documentation with setup guides and code walkthroughs.

Community
Intermediate
VoDaiLoczVoDaiLocz
24

lint-and-validate

Automate linting and static analysis of code in CI pipelines.

Community
Intermediate
as4584as4584
2

architecture-decision-records

Create and manage Architecture Decision Records with multiple templates.

Community
Intermediate