skills.rest
VidyaBodepudi
VidyaBodepudiCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

documentation-and-adrs

Manage documentation standards and Architecture Decision Records for software projects.

2|Updated Apr 13, 2026
Search Tags:#documentation#code comments#APIs#README#ADRs
One-click install
npx skills add https://github.com/VidyaBodepudi/Code-Skills --skill documentation-and-adrs-vidyabodepudi
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-and-adrs
Source: https://github.com/VidyaBodepudi/Code-Skills/tree/main/skills/documentation-and-adrs
Command: npx skills add https://github.com/VidyaBodepudi/Code-Skills --skill documentation-and-adrs-vidyabodepudi

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

Ensures consistent and accurate documentation for features, APIs, and architectural decisions, reducing misunderstandings and improving maintainability.

Core Features & Use Cases

  • Documentation Standards: Enforces best practices for inline code comments, API documentation, and README structure.
  • Architecture Decision Records (ADRs): Encourages recording significant decisions for future reference and consistency.
  • Use Case: When developing a complex feature, this Skill helps maintain a record of the design decisions made, providing a reference for team members and future contributors.

Quick Start

Run the documentation-and-adrs skill to generate documentation for your new feature.

Frequently Asked Questions about documentation-and-adrs

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

FAQPage Schema
What are Architecture Decision Records and when should I use them?▼

To maintain documentation standards, enforce best practices for inline code comments, API documentation, and README structure. This ensures consistent, accurate documentation for features and APIs, reducing misunderstandings and improving project maintainability.

How do I generate documentation for a new software feature?▼

No prior dependencies are required to use this skill. You only need knowledge of documentation best practices and ADR formats to effectively enforce standards for code comments, APIs, and README structure within your software projects.

Why do I need to maintain README structure and API documentation standards?▼

Use ADRs when developing complex features to record significant design decisions for future reference and consistency. They are essential for providing a clear rationale to team members and future contributors about architectural choices made during the project lifecycle.

Can I enforce inline code comments and API documentation standards for my team?▼

This skill focuses on managing documentation standards and Architecture Decision Records, but does not specify limitations regarding particular programming languages or frameworks. It broadly enforces best practices for code comments, APIs, and README structure across software projects.

Related Skills

Explore More Software Engineering Skills→
ArvorCoArvorCo
96

constitution

Create or update a project constitution defining coding principles and governance rules.

Community
Advanced
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
Mte90Mte90
51

Documentation Standards

Enforce documentation standards for code comments, READMEs, and architectural docs.

Community
Basic
EngineerWithAIEngineerWithAI
4

architecture-decision-records

Create and manage Architecture Decision Records in multiple formats.

Official
Intermediate