Cheatsheet template

When to use

• Shelf: resources/cheatsheets/<topic>/
• kind: cheatsheet
• Diátaxis mode: reference (lookup while working)
• Readers served: operators who already know context; agents fetching command syntax quickly

Design rationale

• One-line scope + link to playbook — reference docs must not re-teach the journey (Diátaxis reference).
• Tables over prose — parallel facts (commands, flags, checks) belong in scannable tables (Google reference documentation).
• No paragraph walls between rows — cheatsheets fail when they become mini-guides (NN/g scanning).
• Quick checks table — maps observable pass signals for common ops (runbook verify pattern).
• Mobile-first tables — keep columns few; split sheets if too wide (ZajLibrary mobile-first convention in repo AGENTS.md).

Copy-paste skeleton

---
title: "Topic cheatsheet"
description: One line — what this sheet helps you look up fast.
sidebar:
  label: "Topic cheatsheet"
  order: N
category: <topic>
kind: cheatsheet
status: current
tags: [cheatsheet, topic]
---

One sentence scope. For the full workflow: [Playbook](/tech-stack/laravel/codecanyon/build/playbooks/setup-new/) · [Runbook](/tech-stack/laravel/codecanyon/build/runbooks/code-test-ship/).

## Commands

| Task | Command | Notes |
|---|---|---|
| … | `\`cmd\`` | … |

## Flags & env

| Name | Values | When |
|---|---|---|
| … | … | … |

## Quick checks

| Check | Pass looks like |
|---|---|
| … | … |

Anti-patterns

• Do not duplicate full playbook procedures verbatim.
• Do not add long teaching sections — link out.
• Do not use playbook step checklists as the primary structure.

Worked example

• Laravel operations cheatsheet
• System docs examples

Sources

• Diátaxis — Reference documentation — lookup-oriented cheatsheets.
• Google developer documentation style guide — Reference documents — table-first reference layout.
• Write the Docs — Documentation types — reference vs guide.
• Diátaxis — Overview — cheatsheet complements how-to/playbook.
• Writing style → Doc-type spines