Build Assets
Brand Guideline
Document and Wiki Style
Brand standards for internal documents, specs, and wikis.
Platform: bothTags: documentation, wiki, writing, internal, specs
The Rule
Internal documents follow: one H1 per doc (the title), H2 for major sections, H3 for sub-sections. Bullet points for lists of 3+ items. Tables for comparisons. Code blocks for all code/values. Documents start with a TL;DR or summary section. Status labels: Draft / In Review / Final.
Rationale
Consistent document structure reduces reading friction. When every doc has the same structure, readers know where to find the summary, the decisions, and the status. A shared vocabulary and structure is design systems applied to writing.
Specifications
minimum SizeOne page = one topic. Split documents that exceed 3 printed pages into linked sub-pages.
clear SpaceEvery document: title, status label, author, last updated date in the header.
color VariantsStatus labels: Draft (grey), In Review (yellow), Final (green), Deprecated (red)
Examples
- Good structure: TL;DR → Context → Decision → Rationale → Alternatives considered → Next steps
- Good title: "Button Component Specification v2" — specific and versioned
- Bad title: "Notes" — tells the reader nothing