登录查看更多内容

What does a technical writer do?

由人工智能和领英社区提供技术支持

If you are interested in languages, technology, and communication, you might be wondering what does a technical writer do. Technical writers are professionals who create clear and concise documents that explain how to use, maintain, or troubleshoot products, systems, or processes. They work in various fields, such as engineering, software, medicine, education, or law, and they need to understand the needs and expectations of their target audience. In this article, we will explore the main tasks, skills, and tools of a technical writer in the context of translation.

此文章中的业界达人

由社区从 5 条内容中精选。了解更多

Swaleha Parvin

Technical Writer | Communications Consultant | Google Tech Ambassador | Contact me to Write Impactful Docs for SaaS…
shabnam mootabi

Translator, Content Marketer, English Content Writer

1 Task 1: Research and analyze

Before writing anything, a technical writer has to research and analyze the topic they are going to cover. This may involve reading existing documentation, interviewing subject matter experts, testing the product or system, or reviewing feedback from users. The technical writer has to identify the purpose, scope, and objectives of the document, as well as the profile, level of knowledge, and preferences of the intended readers. They also have to consider the cultural and linguistic aspects of translation, such as terminology, style, format, and conventions.

添加您的观点

Swaleha Parvin

Technical Writer | Communications Consultant | Google Tech Ambassador | Contact me to Write Impactful Docs for SaaS Brands
举报内容
Before penning any document, a technical writer must delve into thorough research and analysis of the subject at hand. This process can include scrutinizing current documents, conversing with experts in the subject matter, directly experiencing the product or system, or examining user feedback. It's crucial for the writer to establish the document's intent, breadth, and goals, alongside understanding the targeted audience's knowledge level, interests, and characteristics. Additionally, they must be mindful of the translation's cultural and linguistic nuances, including the specific terminology, style, format, and accepted norms.

已翻译

赞
Andrew Jenkins

Senior Technical Author
举报内容
Before doing any research or analysis, you need to start building bridges between yourself and the document owners, the subject matter experts , and if possible the end users. These relationships are absolutely critical. If they are weak your document will be weak. That especially means reaching out to those who seem uncooperative. Find out why and fix it: get their trust. Without it your project will struggle.

已翻译

赞

2 Task 2: Plan and outline

Once the technical writer has gathered and organized the relevant information, they have to plan and outline the structure and content of the document. They have to define the main sections, headings, subheadings, and topics, and arrange them in a logical and coherent order. They also have to decide on the tone, voice, and perspective of the document, and how to address the readers. The technical writer may use tools such as mind maps, flowcharts, or diagrams to help them visualize and organize their ideas.

添加您的观点

3 Task 3: Write and edit

The next task of a technical writer is to write and edit the document according to the plan and outline. They have to use clear, concise, and accurate language, avoiding jargon, ambiguity, or redundancy. They have to follow the grammar, spelling, and punctuation rules of the source language, and adhere to the style guide and standards of the project. They also have to use visual elements, such as images, tables, graphs, or screenshots, to support and enhance the text. The technical writer may use tools such as word processors, editors, or markup languages to create and format the document.

添加您的观点

shabnam mootabi

Translator, Content Marketer, English Content Writer
举报内容
When writing for the general audience, it's common to unintentionally use technical language that can be hard to understand. While tools can simplify your writing, real-world experience is irreplaceable. One effective strategy is to randomly select some of your writings and ask others to point out any confusing parts. This simple step can yield surprising insights.

已翻译

赞

4 Task 4: Review and revise

After writing and editing the document, a technical writer has to review and revise it to ensure its quality and consistency. They have to check the document for errors, typos, or inconsistencies in language, content, or design. They also have to verify that the document meets the requirements and expectations of the project, the client, and the readers. They may use tools such as proofreaders, spell checkers, or validators to help them identify and correct any issues. The technical writer may also solicit feedback from colleagues, experts, or users, and incorporate any suggestions or changes.

添加您的观点

5 Task 5: Translate and localize

The final task of a technical writer in the context of translation is to translate and localize the document for the target audience. Translation is the process of converting the text from one language to another, while localization is the process of adapting the text to the culture, context, and conventions of the target market. The technical writer has to ensure that the translated and localized document conveys the same meaning, function, and tone as the original document, and that it is clear, relevant, and engaging for the readers. They may use tools such as translation software, glossaries, or dictionaries to help them with the translation and localization process.

添加您的观点

6 Task 6: Publish and distribute

The last step of a technical writer is to publish and distribute the document to the intended audience. They have to choose the appropriate format, platform, and channel for the document, such as print, web, or mobile. They also have to ensure that the document is accessible, searchable, and user-friendly, and that it complies with any legal or ethical regulations. They may use tools such as content management systems, web servers, or social media to help them with the publication and distribution process.

添加您的观点

Beth Gibson

Manager, Administrative and Maintenance Procedures
举报内容
This part will vary widely depending on whether you're in-house staff of a corporation, or a freelancer, and what you're writing. I've worked for both. The publishing and media was completely out of my control. I only had to provide text in a specific format. Legal and ethical regulations were, and are, outside the scope of my job. In short, technical writers generally are not going to be called upon to also be an IT professional or a legal aide. Another department will be in charge of that scope.

已翻译

赞

7 Here’s what else to consider

This is a space to share examples, stories, or insights that don’t fit into any of the previous sections. What else would you like to add?

添加您的观点

加载更多内容

Translation

+ 关注

给文章评分

我们借助人工智能创建了此文章。您认为这篇文章怎么样？

很棒不太好

举报此文章

查看全部

What does a technical writer do?

1

2

3

4

5

6

7

1 Task 1: Research and analyze

2 Task 2: Plan and outline

3 Task 3: Write and edit

4 Task 4: Review and revise

5 Task 5: Translate and localize

6 Task 6: Publish and distribute

7 Here’s what else to consider

Translation

给文章评分

感谢您的反馈

更多Translation相关文章

更多相关阅读内容