write-design-docs
/write-design-docs
Pisze, poprawia i recenzuje dokumenty projektowe oprogramowania według zasad Malte Ubl z Design Docs at Google: kontekst, cele, nie-cele, kompromisy, alternatywy i kwestie przekrojowe.
- Autor
- pproenca ↗
- Repozytorium
- dot-skills ↗
- Licencja
- MIT
- Ostatnia zmiana repozytorium
- 15.08.2026
Ocena i bezpieczeństwo
- Pliki w paczce
- 4
- Skrypty
- 0
- Komentarze HTML
- 0
- Adresy URL w SKILL.md
- 0
Brak sygnałów. Repozytorium zmienione 15.08.2026, bez odwołań do wycofanych modeli i API.
MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.
Co robi i kiedy
Pisze, poprawia i recenzuje dokumenty projektowe oprogramowania według zasad Malte Ubl z Design Docs at Google: kontekst, cele, nie-cele, kompromisy, alternatywy i kwestie przekrojowe.
Wyzwalacze z opisu
Oryginalny opis (EN)
Write, revise, or review software design documents using Malte Ubl's "Design Docs at Google" guidance. Use when Codex needs to draft a design doc, technical design, RFC, engineering review doc, architecture proposal, mini design doc, or design-doc review focused on context, goals, non-goals, trade-offs, alternatives, cross-cutting concerns, review lifecycle, and deciding whether a design doc is warranted.
Jak działa
- Core Workflow
- Reference
Podgląd SKILL.md
--- name: write-design-docs description: Write, revise, or review software design documents using Malte Ubl's "Design Docs at Google" guidance. Use when Codex needs to draft a design doc, technical design, RFC, engineering review doc, architecture proposal, mini design doc, or design-doc review focused on context, goals, non-goals, trade-offs, alternatives, cross-cutting concerns, review lifecycle, and deciding whether a design doc is warranted. --- # Write Design Docs ## Core Workflow Use the design doc as a problem-solving and consensus-building tool, not as an implementation manual. 1. Decide whether a design doc is warranted. - Write one when the software design is ambiguous, complex, contentious, cross-functional, likely to benefit from senior review, or valuable as organizational memory. - Prefer a short note, issue, or direct implementation when the solution is obvious and there are no meaningful trade-offs. - Prefer a mini design doc for small but non-obvious changes. 2. Gather the minimum context needed to make the design concrete. - Identify the problem, existing landscape, constraints, stakeholders, and decision deadline. - Ask focused questions only when missing information would materially change goals, non-goals, or trade-offs. - State assumptions explicitly when proceeding with incomplete information. 3. Draft around decisions and trade-offs. - Start with objective context and scope. - Define goals and non-goals as explicit boundaries. - Present the selected design from overview to detail. - Explain why the selected design best satisfies the goals under the known constraints. - Compare realistic alternatives, including why they were not selected. - Cover cross-cutting concerns such as security, privacy, reliability, observability, migrations, and operations when relevant. 4. Keep the document readable. - Optimize for busy reviewers who need to understand the decision, not every implementation detail. - Link to detailed requirements, prototypes, schemas, code, or prior docs instead of copying them wholesale. - Include diagrams or compact API/data sketches only when they clarify the design trade-offs. - Avoid large code blocks unless explaining a novel algorithm. 5. Shape the lifecycle. - Mark the document status: draft, in review, accepted, implementing, superseded, or archived. - Suggest the smallest useful review group first, then wider review when the design is stable. - Update the doc while the system has not shipped if implementation reveals wrong assumptions or changed requirements. - Link amendments or follow-up docs when the original doc diverges from reality. ## Reference Read [references/design-doc-guidance.md](references/design-doc-guidance.md) before drafting or reviewing a substantive design doc. Use it for the article-derived template, decision checklist, section guidance, and review rubric.
Pliki w paczce (4)
- SKILL.md 3 KB
- metadata.json 1 KB
- agents/openai.yaml 1 KB
- references/design-doc-guidance.md 6 KB
Wersje
W bazie nie ma innych skilli o nazwie write-design-docs.
Migawka bazy z 13.11.2026 · wersja paczki da40d8d15cf8 (skrót SHA-256 całej paczki)
Pobrania w ostatnich 30 dniach: 1 · ranking
Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.
Podobne skille
- 90technical-spec
Pisze dokumenty projektowe i RFC, które uzgadniają zespół przed kodem: TL;DR, cele i jawne nie-cele, wymagania, projekt end-to-end z trybami awarii, alternatywy, plan wdrożenia i otwarte pytania. - 90design-doc-google-style
Pisze design doc w stylu Google, który uzasadnia decyzję przez kontekst, cele i odrzucone alternatywy przed napisaniem kodu, gdy zmiana jest zbyt duża, by wybrać złe podejście. - 100tech-design-generation
Generuje profesjonalne dokumenty projektu technicznego (design doc, RFC, dokument architektury) według praktyk branżowych, w tym formatu Google Design Doc. - 100arch-design
Prowadzi myślenie projektowe o systemie przed dokumentem lub kodem: cele i nie-cele, szacunki rzędu wielkości, komponenty i kontrakty, tryby awarii, operacyjność, bezpieczeństwo i kompromisy. - 100writing-rfc
Pisze RFC lub dokument projektowy z podsumowaniem na początku, celami, poza zakresem, alternatywami i otwartymi pytaniami. - 100design-docs
Pisze i przegląda dokumenty projektowe RFC oraz ADR z celami, alternatywami, ryzykiem, bezpieczeństwem, wdrożeniem i obserwowalnością.