4:17
What do Technical Writers do? (Also, what is Technical Writing?)
Amruta
Overview
This video explains the role of technical writers in the tech industry by defining technical writing and categorizing the types of documents they produce. Technical writing is presented as a subset of technical communication, focused on conveying complex information to a specific audience. The video details three primary categories of technical documents: UI-based documentation for end-users, Developer documentation for those building applications, and Deployment documentation for integrating software with cloud platforms. The speaker uses the example of YouTube to illustrate each document type and shares their personal experience working across all three categories.
How was this?
Save this permanently with flashcards, quizzes, and AI chat
Chapters
- Technical writing is part of the broader field of technical communication.
- Technical communication involves explaining technically complex information to a specific audience.
- The core elements of technical writing are information and audience.
Understanding the definition of technical writing helps clarify the purpose and scope of a technical writer's work.
- UI-based docs help users navigate and understand a software's user interface.
- This includes documentation for basic user actions like watching videos or managing accounts.
- It also covers more advanced user tasks, such as creating a channel or uploading content.
These documents are crucial for user adoption and satisfaction, enabling people to use software effectively without needing direct support.
YouTube documentation that guides users on how to watch videos, manage playlists, create a channel, and upload content.
- Developer docs assist individuals who want to build applications that interact with a software service.
- This type of documentation often includes information on APIs (Application Programming Interfaces).
- APIs allow external applications to send requests and retrieve data from the service.
Developer docs are essential for fostering an ecosystem around a product, enabling third-party innovation and integration.
Documentation explaining how to use YouTube's APIs to integrate a custom app with YouTube's platform.
- Deployment docs guide users on how to host, configure, and manage their applications, often on cloud platforms.
- This involves understanding and aligning requirements between the application and the hosting environment.
- It requires consulting documentation from both the application's service and the cloud provider.
These documents are vital for ensuring that applications run smoothly, securely, and efficiently in their intended environments.
Guidance on matching YouTube's recommended network bandwidth with DigitalOcean's supported bandwidth for optimal app performance.
- Technical writers may specialize in one type of documentation or work across all three.
- Their ultimate goal is to help users effectively utilize a product.
- This enablement allows users to create their own valuable products or solutions.
This highlights the versatility and impact of technical writers, who bridge the gap between complex technology and user understanding.
The speaker's own work involves creating UI, API (Developer), and deployment documentation for a distributed SQL database.
Key takeaways
- Technical writing is a specialized form of communication focused on making complex information accessible to a target audience.
- The three main categories of technical documents—UI, Developer, and Deployment—serve distinct user needs and purposes.
- UI-based documentation empowers end-users to interact with software interfaces.
- Developer documentation enables other developers to build applications that integrate with a service.
- Deployment documentation assists users in successfully launching and managing their applications in various environments.
- Technical writers play a critical role in product success by ensuring users can understand and leverage technology.
- The work of a technical writer is essential for both user enablement and fostering a broader technological ecosystem.
Key terms
Technical WritingTechnical CommunicationAudienceUser Interface (UI)UI-based DocsDeveloper DocsDeployment DocsAPI (Application Programming Interface)
Test your understanding
- What is the fundamental difference between technical communication and technical writing?
- How do UI-based documents differ from Developer documents in their intended audience and purpose?
- Why is API documentation considered a subset of Developer documentation?
- What challenges might a user face when deploying an application that would require Deployment documentation?
- How does the work of a technical writer contribute to the success of a software product?