skills.rest
mauriciodelrio
mauriciodelrioCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

project-documentation

Generate or update a project's public README and related documentation.

3|Updated Apr 12, 2026
Search Tags:#template#documentation#readme#guidelines#project-setup#english
One-click install
npx skills add https://github.com/mauriciodelrio/delriodev-skills --skill project-documentation-mauriciodelrio
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: project-documentation
Source: https://github.com/mauriciodelrio/delriodev-skills/tree/main/es-skills/agent-workflow/project-documentation
Command: npx skills add https://github.com/mauriciodelrio/delriodev-skills --skill project-documentation-mauriciodelrio

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill guides agents to create, update, and decide where to place public documentation such as README files, API docs, or Storybook, ensuring consistent, concise, English‑first project overviews.

Core Features & Use Cases

  • Single authoritative README: Enforces one root README.md (English) and optional Spanish version.
  • Template generation: Provides a complete README structure with sections for tech stack, setup, scripts, env vars, etc.
  • Update triggers: Recommends updates when scripts, env vars, dependencies, or architecture change.
  • Scope control: Prevents unnecessary READMEs in subfolders unless explicitly requested (e.g., monorepos).

Quick Start

Use the project‑documentation skill to generate a complete README.md for a new repository.

Frequently Asked Questions about project-documentation

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

FAQPage Schema
How do I generate a README for a new software project?▼

To generate a README for a new software project, apply a standardized template covering the tech stack, setup, scripts, and environment variables to produce a concise, English-first project overview.

What sections should a project README include?▼

A project README should include sections for the tech stack, setup instructions, available scripts, environment variables, and architecture details to maintain a consistent, concise structure.

When should I update project documentation?▼

You should update project documentation whenever scripts, environment variables, dependencies, or the underlying architecture change to keep public docs accurately synchronized with the repository.

Should I create separate README files for subfolders in a monorepo?▼

Avoid creating extra READMEs in subfolders unless explicitly requested, enforcing a single authoritative root README.md in English with an optional Spanish version to control documentation scope.

Can I generate project documentation in Spanish?▼

Yes, you can generate an optional Spanish version of the project documentation, while the skill enforces English as the primary language for the single authoritative root README file.

Related Skills

Explore More Software Engineering Skills→
Young-ZYoung-Z
8

x-ipe-task-based-dev-environment

Initializes a development environment by selecting a Python or Node.js tech stack and scaffolding a standard project structure.

Community
Advanced
manastalukdarmanastalukdar
1

docs-sync

Detect code changes and update related documentation files in git workflows.

Community
Intermediate
leboncoinleboncoin
92

create-storybook-docs

Generate and update Storybook stories and MDX docs for Spark UI components.

Official
Basic
Coffelix2023Coffelix2023
1

code-documenter

Generate inline code documentation, API specifications, and developer guides.

Community
Intermediate