19 hours ago · 18 min read3508 words · Tech · hide · 0 comments

When you take on a small documentation project, you can inform each step with data. It might seem like overkill. Small projects are often ones that you tend to consciously plan or build a process around — they’re mostly an execution task: An interrupt from a colleague that you pick up while on triage, letting you know that they changed the title of a chart in a dashboard. A tag from someone on a Slack thread where a customer is confused about when a specific type of query is run. A page quality feedback comment asking how often the data in a dashboard is updated. It’s easy to treat each small documentation request as an important task to deliver, especially with AI-driven workflows. Avoid bloating the content, and thus the context that your reader must absorb, by using data to inform even small documentation requests and determine whether to write something at all. When you work on a project this small, the phases look somewhat different from those of a medium or large-sized project:…

No comments yet. Log in to reply on the Fediverse. Comments will appear here.