Skip to content
tezvyn:

Design a scalable documentation system for three engineering teams

Source: scribe.comMediumHow cards are made

Design a scalable documentation system for three engineering teams

Tests prioritization and process design for a sole writer supporting three engineering teams. Strong answers use tiered intake with SLAs, a public Kanban board, and async status updates. Red flag: ad-hoc prioritization through Slack DMs with no queue.

What's really being asked

This question tests your ability to build operational systems rather than just write documents. The interviewer wants to see if you can manage throughput, set boundaries, and create transparency when you are the only writer supporting multiple engineering teams. They care about scalability, stakeholder communication, and how you make tradeoffs visible.

The full answer

First, intake standardization. Describe a single intake form or issue template that captures request type, audience, deadline, and business impact. Second, tiered prioritization. Define clear tiers such as P0 for launch blockers, P1 for feature updates, and P2 for backlog improvements, each with SLA targets like 48 hours or five business days. Third, public workflow. Use a Kanban board or docs-as-code GitHub project so teams can see queue depth and status without asking you directly. Fourth, async communication. Set up automated status comments, a weekly digest, or a dedicated Slack channel for updates rather than one-off DMs. Fifth, publication and feedback loops. Merge requests trigger publication via CI/CD, and a short feedback link on every page closes the loop.

The mistakes people make

A major red flag is suggesting you will attend every team standup or prioritize via Slack DMs. That signals you will be a communication bottleneck. Another mistake is treating all requests as first-come-first-served without business impact scoring. Proposing a heavy ITSM ticketing system can also be a red flag because it adds friction for a three-team startup. Scribe notes that when Spotify used scattered tools like Google Docs and Confluence without outlined workflows, not finding the right information became a top productivity blocker, so fragmented systems are a risk. Finally, failing to mention self-service options like templates or auto-generated API docs suggests you do not think about scaling beyond manual writing.

What usually comes next

The interviewer may ask how you handle a last-minute executive request that jumps the queue, how you measure documentation quality or team satisfaction, or what you do when all three teams hit a release deadline in the same week. They may also probe how you would onboard a second writer into the system you built.

A concrete example

Say Team A needs API reference updates for a Friday launch, Team B needs a runbook for a new microservice, and Team C needs a revised onboarding guide. Your intake form tags the API update as P0 due to revenue impact with a two-day SLA. The runbook is P1 with a one-week SLA because it is internal only. The onboarding guide is P2. All three requests appear as cards on a GitHub project board labeled by tier and due date. Each team gets a weekly Slack digest showing where their cards sit in the queue. When a draft is ready, the writer tags the requesting engineer in a pull request; on merge, the site deploys automatically and the card moves to done.

Interview question

A sole writer supporting three teams is overwhelmed by Slack DM status requests. Which change best fixes the root cause and scales the system?

  • a.Deploy a formal ITSM ticketing system requiring approvals before any documentation request
  • b.Publish a public Kanban board with tiered SLAs and replace DMs with automated weekly digestsCorrect
  • c.Block two hours daily to answer status DMs and update stakeholders in real time
  • d.Attend all three teams' daily standups to give live progress updates each morning
Why?

A public board with tiered SLAs and automated digests lets teams self-serve status updates without interrupting the writer, whereas attending every standup turns the writer into a communication bottleneck and a heavy ITSM system adds unnecessary friction for a three-team setup.

Just read this? Test yourself on what you have been reading.

Read the original → scribe.com

You just looked this up. Could you explain it out loud?

That is the part interviews actually test. Tezvyn takes questions like this one and gives you what the interviewer is really checking, the answer that lands, and the mistake that ends the conversation, in the four minutes before your next meeting.

The iPhone app is on the way

We are building it. Until it lands, nothing here is held back from you: every interview card, your saved cards, streaks and the job board all work in Safari, plus hundreds of free practice quizzes of thirty questions each. Sign in and it all carries over to the app the day it arrives.

Want it as an icon? Tap Share at the bottom of Safari, then Add to Home Screen. It opens full screen and the cards you have read stay available offline.

Get it on Google PlayiPhone app coming soon

We are hiring for this. Every open role lists the topics its interview covers, so you can prepare for the real thing rather than guessing.

See open roles