skills.rest
SEBAKHI
SEBAKHICOMMUNITY
Explore all skills by this author →
GitHub

documentation-standards

Provide standardized templates for code documentation, README files, and ADRs.

1|2|Updated Nov 2, 2025
Search Tags:#templates#documentation#adr#readme#code comments#standards
One-click install
npx skills add https://github.com/SEBAKHI/Auth --skill documentation-standards-sebakhi
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-standards
Source: https://github.com/SEBAKHI/Auth/tree/main/.claude/skills/documentation-standards
Command: npx skills add https://github.com/SEBAKHI/Auth --skill documentation-standards-sebakhi

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides clear, standardized templates for essential project documentation, ensuring consistency and quality across your codebase and architectural decisions.

Core Features & Use Cases

  • Code Documentation: Offers a comprehensive C# XML doc comment example for methods, including parameters, return values, exceptions, and examples.
  • README Template: Provides a structured Markdown template for project README files, covering setup, configuration, architecture, and development.
  • ADR Template: Includes a template for Architecture Decision Records (ADRs) to document significant technical choices.

Quick Start

Use the documentation-standards skill to generate a standard README file for a new project.

Frequently Asked Questions about documentation-standards

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

FAQPage Schema
What is an Architecture Decision Record and when do I need one?▼

A README template standardizes project overviews by providing a structured Markdown format. It covers essential setup, configuration, architecture, and development sections to ensure consistent high-quality project documentation.

How do I write standardized code comments for methods?▼

To write a project README, use a standardized Markdown template covering setup, configuration, architecture, and development sections. This enforces best practices for consistent project overviews and high-quality documentation.

What's the best way to standardize project documentation across a codebase?▼

Standardizing project documentation requires applying consistent templates for code comments, README files, and ADRs. This enforces high-quality documentation practices and ensures architectural choices are captured uniformly across the codebase.

Does the documentation template include examples for C# XML doc comments?▼

Yes, the C# XML doc comment example is included for methods. It covers parameters, return values, exceptions, and examples, facilitating consistent and high-quality code documentation practices for software development projects.

Can I use these templates for documenting any architectural choices?▼

Yes, you can use the ADR template to document significant technical choices. It provides a standardized structure for recording architectural decisions, ensuring consistent and high-quality documentation of architectural choices across projects.

Related Skills

Explore More Software Engineering Skills→
benshapyrobenshapyro
9

documentation-templates

Generate README, API docs, and inline comment templates for software projects.

Community
Basic
DriveConnect-alphaDriveConnect-alpha
1

documentation-templates

Generate standardized markdown documentation templates for new projects.

Official
Intermediate
TeiNamTeiNam
12

laravel-verification

Automate Laravel project verification for CI/CD pipelines.

Community
Advanced
xbklairithxbklairith
2

documentation

Generate code docstrings, API references, READMEs, and Mermaid architecture diagrams.

Community
Intermediate