skills.rest
AsiaOstrich
AsiaOstrichCOMMUNITY
Explore all skills by this author →
𝕏@AsiaOstrichGitHub

documentation-guide

Guide project documentation structure and content requirements with templates.

70|13|Updated Dec 24, 2025
Search Tags:#architecture#documentation#api#project structure#adr#readme
One-click install
npx skills add https://github.com/AsiaOstrich/universal-dev-standards --skill documentation-guide-asiaostrich
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-guide
Source: https://github.com/AsiaOstrich/universal-dev-standards/tree/main/.gemini/skills/documentation-guide
Command: npx skills add https://github.com/AsiaOstrich/universal-dev-standards --skill documentation-guide-asiaostrich

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses the challenge of inconsistent and incomplete project documentation by providing clear guidelines, templates, and best practices for creating effective READMEs, architecture documents, and more.

Core Features & Use Cases

  • Standardized Structure: Defines optimal file organization and naming conventions for documentation.
  • Content Requirements: Outlines necessary sections and information for various project types (new, refactor, etc.).
  • Templates: Offers pre-defined structures for README.md, ARCHITECTURE.md, API.md, and ADRs.
  • Use Case: When starting a new project, use this Skill to ensure your README, ARCHITECTURE.md, and DEPLOYMENT.md files are comprehensive and follow best practices from day one.

Quick Start

Use the documentation guide skill to generate a standard README.md file for a new project.

Frequently Asked Questions about documentation-guide

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

FAQPage Schema
What is the best way to structure project documentation for a new software architecture?▼

Standardizing project documentation structure requires defining optimal file organization and naming conventions for core files like README, ARCHITECTURE, and API documents to ensure comprehensive coverage from day one.

How do I write a comprehensive README.md file for my software project?▼

Writing a comprehensive README.md file involves following pre-defined templates and content guidelines that outline necessary sections and information tailored to your specific project type.

What sections should be included in an ARCHITECTURE.md document?▼

An ARCHITECTURE.md document should include sections detailing the system architecture, database schemas, deployment procedures, and migration guidelines based on standardized best practices.

When do I need to create an ADR for my project?▼

You need to create an Architecture Decision Record (ADR) when documenting significant architectural choices, using provided templates to capture context, decisions, and consequences for quality assurance.

Can I use these documentation guidelines for a project refactor?▼

Yes, you can use these documentation guidelines for a project refactor, as they outline necessary sections and provide checklists tailored to various project types including refactoring scenarios.

Related Skills

Explore More Software Engineering Skills→
daikichiba9511daikichiba9511
1

zettel-init

Create Zettelkasten directory structures with index.md, structs/, and outputs/ templates.

Community
Intermediate
zzafergokzzafergok
1

markdown-to-html-skill

Convert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.

Community
Intermediate
massgenmassgen
1.1k

pr-checks

Automate PR checks with pre-commit hooks, tests, and CodeRabbit feedback.

Official
Advanced
FaysilAlshareefFaysilAlshareef
4

api-docs

Enrich OpenAPI specifications with summaries, descriptions, and examples.

Community
Intermediate