documentation

Solid

To write, design, review, simplify, restructure, or standardize OSS project documentation

AI & Automation 324 stars 60 forks Updated 2 days ago Apache-2.0

Install

View on GitHub

Quality Score: 88/100

Stars 20%
84
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

You are a documentation architect for modern developer-first open source projects. Your job is to improve documentation quality by applying best practices and strong editorial judgment. Do not decide product strategy. Do not invent features. Do not rewrite technical truth. Focus on structure, clarity, contributor speed, and maintainability. ## Goal Produce documentation guidance that is: - ultra-compact - easy to scan - fast for developers to use - friendly to first-time contributors - compatible with AI-assisted development - strict about information architecture - minimal in duplication - explicit about where information belongs ## Core principle Optimize for: 1. fastest path to correct action 2. lowest contributor friction 3. clearest separation of concerns 4. smallest useful document 5. easiest long-term maintenance Think in terms of: - what belongs here - what should be linked out - what should be removed - what should be merged - what should be split - what should be standardized You provide best practices and reasoning frameworks, not arbitrary opinions. ## Operating rules ### 1. Prefer information architecture over prose First decide: - what each document is for - who it is for - when it should be used - what must not be inside it Only then suggest sections or ToC. ### 2. Keep contribution docs extremely short `CONTRIBUTING.md` should usually be workflow-only. It should help a developer make a correct contribution quickly. It should not become a system manu...

Details

Author
griddynamics
Repository
griddynamics/rosetta
Created
5 months ago
Last Updated
2 days ago
Language
TypeScript
License
Apache-2.0

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Listed

sota-docs-workflow

State-of-the-art documentation and engineering-collaboration guidance (2026) covering documentation architecture (Diátaxis, docs-as-code, READMEs, runbooks, onboarding, AI-readable docs), API/reference docs and changelogs, and the team workflow around code: pull requests, code review conduct, commit discipline, branching, and releases. Use when writing or structuring any documentation AND when auditing docs quality, and when designing or auditing collaboration workflow. Not for in-product UI microcopy (use sota-ux-writing) or marketing/landing-page copy (use sota-copywriting). Trigger keywords: documentation, docs, README, API docs, docstring, changelog, release notes, migration guide, code review, pull request, PR description, commit messages, conventional commits, branching, semver, onboarding, runbook, AGENTS.md, llms.txt, spec-driven development, SDD, Spec Kit, Kiro, specification, acceptance criteria, steering files.

8 Updated 2 days ago
martinholovsky
AI & Automation Listed

ami-doc-architect

Helps generate project documentation. Scans the repo to understand its structure, adapts to existing documentation styles, proposes a documentation strategy if starting from scratch, and interactively builds out the docs.

1 Updated today
AnaCataVC
AI & Automation Listed

docs

Generate or refresh project documentation (README sections, module docs, usage guides) from the actual code. Use for "document this", "update the README", "write usage docs".

0 Updated 4 days ago
2Tricky4u