design-doc skillA
design-doc is agent-read markdown (skill) from lamngockhuong/aiteamkit: Write the technical design document a team reviews before coding, plus the ADR that records the decision behind it: current state, options with trade-offs, chosen approach, data and API changes, migration and rollback, risks, and the reviewers who must sign off. Use before implementing anything that touches a schema, a public contract, a shared module, or more than one service. Triggers on: "design doc", "technical design", "tech design", "thiết kế kỹ thuật", "tài liệu thiết kế", "ADR", "archite.
Indexed from public GitHub and served as immutable, content-addressed versions. Install it pinned to an exact SHA-256 with the mdr CLI, and every file is verified against the hash recorded here before it reaches your agent. The deterministic audit below grades the latest version, and the same file always earns the same grade.
What the file says
# Technical Design Document (`atk:design-doc`) Produces the document a Tech Lead and peers can review without a meeting, and the ADR that survives the people who wrote it. The point is the comparison: a design with only one option is a plan, not a design, and gets reviewed as such. ## Scope Handles: describing the current implementation with citations, framing the problem, comparing viable options against stated criteria, specifying the chosen data model, API contracts, and the migration and rollout sequence the change requires, and writing the ADR entry. Does NOT handle: writing the requirement (`atk:intake`), sizing (`atk:estimate`), or the implementation itself. It chooses the approach and stops there: sequencing the chosen approach into phases and steps is `atk:plan`, which never reopens the choice. It also does not approve its own design: review is a separate role. It does not keep anything current either. This document argues for a change and cites the code as it stood before it, so the day the change merges the citation stops being true and what is left is an account of a decision. What the system does from then on is `atk:spec`, per `shared/spec-docs.md`. ## Roles …
Read the whole file at its exact version.
How to install
mdr add lamngockhuong/aiteamkit/design-doc@git:20260924.59d6cfamdr add lamngockhuong/aiteamkit/design-doc@sha256:b8426bfe285f629cPin to a label to follow the author's releases, or to a sha256 to freeze the exact bytes forever. Either way the resolved hash is written to mdr.lock, and mdr install reproduces it on any machine.
[](https://markdownregistry.com/a/art_rwmxpfixcixudefg)
1 badge views in 30 days
Versions
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260924.59d6cfa latest | 2026-09-24 | 59d6cfa | 7,025 B | A | view · diff |
| git:20260920.d282a91 | 2026-09-20 | d282a91 | 6,170 B | A | view · diff |
| git:20260918.73a33f4 | 2026-09-18 | 73a33f4 | 5,832 B | A | view · diff |
| git:20260918.dcc08e9 | 2026-09-18 | dcc08e9 | 5,726 B | A | view · diff |
| git:20260918.cddb693 | 2026-09-18 | cddb693 | 5,259 B | A | view · diff |
| git:20260917.01d91de | 2026-09-17 | 01d91de | 4,731 B | A | view |
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (7025 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
lamngockhuong/aiteamkit · 5 stars · license MIT · pushed 2026-09-24 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_rwmxpfixcixudefg GET https://markdownregistry.com/api/v1/resolve?ref=lamngockhuong/aiteamkit/design-doc GET https://markdownregistry.com/api/v1/blob/b8426bfe285f629c57fa140deeb88d0d00f7760194c89cfd8e4cc666325ea599
Your agent does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
More from lamngockhuong/aiteamkit
Every file in lamngockhuong/aiteamkit