How Docs Scale
Technical writing isn’t just about creating documents; it’s about designing systems that scale knowledge. As AI takes on structured tasks, the role of technical writers is shifting faster than ever. Here’s my take on where we’re headed.
Docs that are in the daily workflow
Lately, my focus has shifted from drafting individual documents to designing a more integrated approach to documentation. The idea is straightforward: embed docs into developers’ daily workflows.
Why should documentation be part of the daily workflow? Because it ensures reliability and efficiency. Without it, developers waste valuable time searching for the information they need. At its core, a good documentation system facilitates both the accessibility and creation of knowledge. Our task is to enhance these aspects, benefiting not only individual developers but the team as a whole.
From this perspective, designing systems becomes just as crucial as the act of writing itself. Why? Because systems scale, while meticulously crafting specifications for each technology does not. If developers are empowered to write their own documentation within a well-designed system, knowledge flows more naturally and sustainably across the organization.
A Brief History of Technical Writing
The role of the technical writer emerged during World War II, when their primary skill was adhering to strict government specifications. As technology became more widespread, the focus shifted: technical writers transitioned to creating user manuals for the general public.
The evolution of technical writing reflects the changing needs of the industries it serves. From adhering to strict wartime specifications to simplifying complex technologies for the public, the role of the technical writer has continually adapted. Today, as AI and automation reshape how we work, technical writers face a dual challenge: training AI systems while simultaneously improving human workflows. This dual focus requires us to think beyond traditional documentation practices, embracing a more holistic approach to knowledge management.
The Role of AI in Documentation
Now, in the AI era, rigid and precise technical writing seems destined for machines. AI will likely surpass humans in producing structured, disciplined documentation. But this shift introduces a new challenge: technical writers must develop principles tailored to educating AI. At the same time, our focus should remain on enhancing the developer experience. After all, the true measure of documentation is not its perfection but its ability to help developers work more effectively with documentation.
Technical writing is no longer just about creating polished documents; it’s about fostering a culture where knowledge is continuously shared and trefined. As we redefine our role, we must ask: how can we make documentation a seamless part of the development process? By embedding it in the rhythm of daily work, we create a system where learning and doing converge—a system that benefits not just developers, but the entire organization.
In the end, the success of documentation system is how seamlessly they empower teams to share and grow their collective knowledge.
You can find what I'm working on here: https://toss.tech/article/31643