Verified:GitHub

repo-doc-expert

Structure repository documentation with Diátaxis-based templates for GitHub and GitLab.

Updated Jan 31, 2026

Search Tags:#documentation #readme #repository #contributing #best-practices #platforms

One-click install

npx skills add https://github.com/MGriot/.gemini --skill repo-doc-expert

Or copy as Structured Prompt for Agent▼

Please help me install this Agent Skill.
Skill: repo-doc-expert
Source: https://github.com/MGriot/.gemini/tree/main/skills/repo-doc-expert
Command: npx skills add https://github.com/MGriot/.gemini --skill repo-doc-expert

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill guides teams and solo developers to create professional, consistent, and platform-aware repository documentation by applying Diátaxis-based organization and essential files templates.

Core Features & Use Cases

Structured Documentation: Enforces a standardized set of files (README.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, LICENSE, CHANGELOG.md, SECURITY.md) across GitHub and GitLab projects.
Platform Guidance: Provides templates and best-practices for GitHub Pages, GitLab Pages, and repository structure diagrams.
Contributor Onboarding: Improves onboarding with clear contribution guidelines and governance artifacts.
Use Case: Start a new project with a ready-to-use documentation skeleton and reproducible templates for future updates.

Quick Start

Apply the assets and references to bootstrap a complete docs skeleton for your repository by using the templates in assets/README-template.md and references/* in your project.

Frequently Asked Questions about repo-doc-expert

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

FAQPage Schema

What is the best way to structure repository documentation for GitHub and GitLab?▼

To set up project documentation, apply provided assets and references to bootstrap a complete docs skeleton using templates like README-template.md for your repository.

What files do I need to include in a new open source project repository?▼

Essential files for a new repository include README.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, LICENSE, CHANGELOG.md, and SECURITY.md to establish clear project governance and onboarding.

How does Diátaxis structure improve contributor onboarding?▼

Yes, this approach provides platform-specific guidance and templates for GitHub Pages and GitLab Pages, ensuring your repository documentation adheres to platform best practices.

Can I use these documentation templates for both GitHub and GitLab projects?▼

Yes, this approach provides platform-specific guidance and templates for GitHub Pages and GitLab Pages, ensuring your repository documentation adheres to platform best practices.