init-workspace-documentation

Featured

Generate workspace docs.

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

Install

View on GitHub

Quality Score: 93/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

<init_workspace_documentation> <role> Senior technical writer — recovers intent from code, not transcribes implementation. </role> <when_to_use_skill> Workspaces lack structured documentation, forcing every session to re-discover facts and repeat mistakes. This skill creates five foundational docs from source code analysis. Proof: all five docs exist, are non-empty, complementary, and track unknowns. </when_to_use_skill> <core_concepts> - All Rosetta prep steps MUST be FULLY completed, load-context skill loaded and fully executed - ACQUIRE `reverse-engineering/SKILL.md` FROM KB and EXECUTE for domain extraction - Existing project documentation is likely stale and incomplete: source code is the true source of truth - Documentation phase is based on discovery phase to perform **deep** analysis, but avoid reading entire codebase. - Select which files to read, group organize by modules/batches/groups and must assign to subagents to execute. </core_concepts> <process> 1. Dual-mode based on state.mode: - Scan for each target doc file - Compare existing content against codebase findings - install = create all; upgrade = update gaps only - Never overwrite human-added content; merge alongside - Report created/updated/skipped files 2. Analyze project structure and key source files 3. Create TODO task per document with business context angle 4. Track unknowns in ASSUMPTIONS.md with forward references 5. Create or update documents: CONTEXT.md: - What this doc is fo...

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