Documentation
64 bites tagged Documentation — interview questions with model answers, and 60-second explainers.
Designing an API for power vs novice personas
Power users want control, batching, and precise errors; novices want defaults, guardrails, and guidance; both want consistency. Whether personas drive concrete API tradeoffs.
Public API design versus internal API design
Public needs strict versioning, long deprecation, scoped auth like OAuth and API keys, and polished docs; internal can move faster. public APIs are long-lived contracts.
Essential sections of a post-mortem
Summary, impact, timeline, root cause, lessons, and owned action items, each with a clear purpose. Post-mortem structure. a narrative with no timeline or no concrete, tracked follow-ups.
Anatomy of an effective runbook
Alert meaning and impact, diagnostic steps with dashboard and query links, concrete remediation with rollback, and escalation contacts. knowing what makes a runbook usable under stress.
Versioned documentation site for a design system
Snapshot docs per release, version-prefixed routes, a version switcher, canonical latest. Versioned docs architecture. Serving only latest docs from a single live source with no historical snapshots or version routing.
Essential docs for onboarding a new team
Getting-started guide, per-component API and usage docs, design guidelines and tokens, plus changelog and migration notes. Whether you can make a system self-serve.
Purpose and key sections of CONTRIBUTING.md
It documents how to contribute; key sections are setup and dev workflow, contribution process and standards, and review and release expectations. Whether you lower the barrier to good contributions.
Storybook's role in design system infrastructure
Isolated development, living documentation, visual and interaction testing, shared review surface. why a component explorer matters. describing it only as a dev playground with no testing or docs value.
Measuring design system documentation effectiveness
Search-with-no-results, time-to-first-component, support-ticket deflection, tied to analytics and registry data. outcome metrics over vanity page views. citing only page views or NPS with no instrumentation.
Documenting component anti-patterns and don'ts
Paired do/don't examples, explain the why, enforce with lint rules. guiding correct usage by showing failure modes. vague prose warnings with no concrete counter-example or guardrail.
Auto-generating component API docs from source
Extract types via react-docgen-typescript, surface in Storybook ArgsTable, enrich with JSDoc. keeping prop docs in sync with code. maintaining a hand-written prop table that silently drifts.
Structuring Storybook stories for visual states
One named story per state with explicit args, plus argTypes and controls. organizing component documentation in an explorer. dumping every state into one story with manual prop toggling.
Component Stability Index
A component stability index is a maturity signal that tells consumers how safe a design-system component is to use, from experimental to stable to deprecated, setting expectations about API churn and supporting confident adoption decisions.
Structuring docs for multiple audiences
Layer docs by audience, give developers API and code, designers usage and design guidelines, PMs principles and coverage, with shared foundations like tokens and accessibility. audience-aware documentation strategy.
The role of Storybook in a design system
Storybook renders components in isolation across states, serving as living documentation, a development sandbox, and a base for visual and accessibility testing. understanding of component workbenches.
Documenting a single UI component
Purpose and when to use, a props API table, live examples of variants and states, accessibility notes, and do and don't guidance. Knowing what good component docs contain. documenting only the prop list with no usage guidance.
Component versus pattern in a design system
A component is a single reusable UI building block; a pattern is a documented way of composing components to solve a recurring problem. vocabulary precision. using the two terms interchangeably.
Documentation for a new Card component
Usage guidance and do/don't, variants, accessibility, code examples, composition. complete component docs, not just an API table. shipping only a props table with no when-to-use, accessibility, or examples.
Architecting a federated documentation site
Docs-as-code with a manifest, CI publishing artifacts, a build that pulls and merges, unified deploy. aggregating docs from many repos into one site. manually copy-pasting docs between repos with no automated aggregation.
Documenting accessibility per component
Per-component a11y sections, keyboard tables, ARIA roles and states, live examples. making accessibility actionable, not a generic page. one global accessibility page with no component-specific keyboard or ARIA detail.
Nuxt ships Nuxi AI agent with context-aware docs help
Nuxt's AI agent Nuxi grounds answers in docs, modules, and GitHub issues using your current page context. GitHub sign-in syncs chats across devices, while branching lets you fork conversations. Use it to cut doc-hunting time and find v4 patterns faster.
VitePress 1.0 replaces VuePress for docs
VitePress 1.0 replaces VuePress, powering docs for Vite, Pinia, and Vitest. It serves static HTML for SEO, then hydrates into a Vue 3 SPA with sub-100ms edits. Migrate legacy VuePress docs or choose it for new content sites.
Topline Report: The Research Snapshot
A topline report is the snapshot of a study: goals, key learnings, and context in one doc. Teams use it to align stakeholders days after research, sometimes before full analysis. Never skip the disclaimer or stakeholders will treat impressions as final.
What are FastAPI's two default interactive documentation UIs and URL paths?
This tests whether you know FastAPI's built-in auto-generated docs. A strong answer names Swagger UI at /docs and ReDoc at /redoc, then notes the OpenAPI schema at /openapi.json. A weak answer confuses these with external tools or custom routes.
Get Documentation bites daily.
Five a day, five minutes, offline. With quizzes so it sticks.
Open testing — you’ll join as an early tester.