What I wish I knew ... about being a technical writer

Summary

The speaker manages a technical writing team responsible for documenting APIs used by Windows developers, ensuring comprehensive coverage and timely publication. They collaborate closely with feature teams, create introductory materials, tutorials, and maintain the accuracy of content across hundreds of thousands of topics. The challenge lies in coordinating the team's efforts to meet deadlines, localize content, and manage updates efficiently, all while minimizing disruption.

Takeaways

• 📝 The speaker manages a team of technical writers responsible for documenting APIs used by Windows developers.
• 🔍 They work closely with feature teams to stay informed about upcoming changes and developments in Windows.
• 📖 The team is tasked with writing introductory material, creating tutorials, and documenting all APIs for Windows apps.
• 🗓 The manager's role is to ensure the team meets deadlines and covers all the necessary topics in their documentation.
• 🌐 The documentation is extensive, with hundreds of thousands of topics that need to be maintained and updated.
• 🌐 Localization is a key aspect of their work, ensuring that the documentation is accessible to a global audience.
• 🔄 The team must manage changes to content, ensuring that all updates are accurate and consistent.
• 🕒 Timing is crucial; documentation must be published at the right time, neither too early nor too late.
• 👥 The manager's goal is to facilitate the team's work with minimal disruption, ensuring smooth operations.
• 🛠️ The process of publishing documentation involves much more than what people might assume, including a complex backend system.
• 🙏 The speaker expresses gratitude for the opportunity to discuss their role and the work of their team.

Q & A

What is the primary responsibility of the team managed in the script?

The team's primary responsibility is to document all the APIs that Windows developers use, which includes creating tutorials and writing the documentation necessary for app development on Windows.

How does the team work with feature teams?

The team works closely with feature teams to discover new and interesting features coming to Windows and to plan the writing of introductory material and documentation for these features.

What are some of the challenges faced by the team in meeting their deadlines?

Challenges include ensuring that all content is covered, managing the publishing process to avoid premature or delayed releases, and coordinating with feature teams to stay updated on upcoming changes.

How large is the team mentioned in the script?

The team consists of about a dozen technical writers.

What is the scale of the documentation work that the team handles?

The team handles a vast amount of documentation, with hundreds of thousands of different topics that need to be maintained and updated.

What is involved in the publishing process of the documentation?

The publishing process involves ensuring that all content is localized, changes are correctly implemented, and everything is published at the right time.

Why is it important for the documentation to be published at the right time?

Publishing at the right time is crucial to avoid revealing information too early or missing important deadlines, which can disrupt the development process for Windows apps.

What does the script imply about the complexity of the documentation system?

The script implies that the documentation system is complex, involving a large number of topics and requiring careful management to ensure accuracy and timeliness.

How does the manager ensure that the team's work is minimally disruptive?

The manager helps the team to complete their tasks with minimal disruption by coordinating with feature teams, managing deadlines, and overseeing the publishing process.

What role does the manager play in the team's success?

The manager plays a critical role in the team's success by helping to meet deadlines, ensuring all content is covered, and overseeing the publishing process to minimize disruptions.

What are some of the potential issues that can arise from improper documentation management?

Potential issues include incorrect information being disseminated, developers being uninformed about new features, and delays in the development and release of Windows apps.