skills.rest
fieldsphere
fieldsphereOFFICIAL
Explore all skills by this author →
GitHub

update-readme

Generate repository READMEs with startup instructions and Mermaid architecture diagrams.

37|20|Updated Mar 2, 2026
Search Tags:#documentation#onboarding#mermaid#readme#update-readme#architecture-diagram
One-click install
npx skills add https://github.com/fieldsphere/cursor-team-marketplace-template --skill update-readme-fieldsphere
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: update-readme
Source: https://github.com/fieldsphere/cursor-team-marketplace-template/tree/main/plugins/technical-writing/skills/update-readme
Command: npx skills add https://github.com/fieldsphere/cursor-team-marketplace-template --skill update-readme-fieldsphere

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill eliminates the tedious manual effort of keeping READMEs fresh, onboarding docs, and architecture diagrams in sync by generating a coherent README from repository signals.

Core Features & Use Cases

  • Generate startup instructions aligned to the repository's structure and dependencies.
  • Create a Mermaid architecture diagram for quick onboarding and architectural clarity.
  • Preserve existing manual sections (badges, license, contributing guidelines) and update only the startup and architecture sections.

Quick Start

Run the update-readme skill on a repository to generate or refresh its README with startup instructions and a Mermaid architecture diagram.

Frequently Asked Questions about update-readme

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

FAQPage Schema
How do I generate a README with architecture diagrams for my repository?▼

Generate a README with architecture diagrams by analyzing repository signals like code structure and dependencies. The output includes startup instructions and a Mermaid architecture diagram, providing a coherent onboarding document.

Can I update startup instructions in a README without overwriting manual sections?▼

Yes, updating startup instructions preserves existing manual sections such as badges, licenses, and contributing guidelines. Only the startup and architecture sections are refreshed while maintaining manually authored content.

What is the best way to create onboarding documentation with a Mermaid diagram?▼

Create onboarding documentation with a Mermaid diagram by analyzing repository entry points and dependencies. This generates a ready README containing startup steps and architectural clarity for quick onboarding.

How does generating a README from repository signals work during project handoffs?▼

Generating a README during project handoffs works by analyzing code structure and dependencies to output startup instructions and a Mermaid diagram. This eliminates manual effort and keeps onboarding documentation in sync.

Does the generated README startup instructions support repositories with complex dependencies?▼

Yes, generated startup instructions support repositories with complex dependencies by analyzing repository signals. The output aligns startup steps to the repository's specific structure and dependency configuration.

What to do when my README architecture diagram is out of sync with the codebase?▼

When a README architecture diagram is out of sync, run an update to regenerate the Mermaid diagram and startup instructions. This refreshes the architecture section based on current repository signals without losing manual content.

Related Skills

Explore More Content & Communication Skills→
queen-of-codequeen-of-code
8

agent-explorer

Analyze a codebase and produce a read-only structural summary.

Community
Intermediate
odylithodylith
34

odylith-atlas-render

Render Atlas diagrams from Yardl or other sources into Minecraft's Yak? No, Yak is not involved. Actually, reprocess the request: convert Mermaid catalog data to Atlas diagrams and export them as SVG or PNG files for use in documentation and presentations.

Official
Intermediate
POWERFULMOVESPOWERFULMOVES
1

code-documentation

Generate API references, README files, inline comments, and architectural decision records.

Community
Intermediate
dmlguq456dmlguq456
7

analyze-project

Analyze codebases and generate structured Markdown documentation in .claude_reports/docs_code/.

Community
Advanced