登录查看更多内容

What are the technical communication standards for industry?

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

Technical communication is the process of conveying information and instructions to a specific audience for a specific purpose. It involves creating, designing, and delivering various types of documents, such as manuals, reports, proposals, presentations, and websites. Technical communication standards are the rules and guidelines that ensure the quality, clarity, accuracy, and usability of these documents. In this article, you will learn about some of the common technical communication standards for industry and why they are important for your career.

在这篇协作文章中查找专家回答

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

1 Audience analysis

One of the first and most important steps in technical communication is to analyze your audience. You need to know who will read, use, or benefit from your document, what their needs, expectations, and goals are, and how they will access and interact with your document. Audience analysis helps you tailor your content, tone, style, and format to suit your audience's preferences and level of expertise. It also helps you avoid unnecessary jargon, assumptions, or technical errors that might confuse or frustrate your audience.

添加您的观点

2 Document design

Another key aspect of technical communication is to design your document effectively. Document design refers to the visual and structural elements that organize and present your information, such as layout, typography, color, graphics, headings, lists, and tables. Document design helps you enhance the readability, attractiveness, and accessibility of your document. It also helps you create a consistent and professional look and feel that reflects your purpose, message, and brand. Document design should follow the principles of alignment, contrast, repetition, and proximity to create a balanced and harmonious layout.

添加您的观点

John Sanchez

? I help FP&A professionals accelerate their careers with LEVERAGED* training. * We leverage the 80/20 rule to focus on the 20% of skills that get you 80% of results
举报内容
The IBCS standards provide these design standards for reports, presentations, dashboards and the charts and tables they contain. If you work in finance or accounting, especially, the standards can help provide a framework to create consistency in your communication.

已翻译

赞

3 Content development

Content development is the core of technical communication. It involves researching, writing, editing, and proofreading your information and instructions. Content development helps you create clear, concise, and coherent content that conveys your message and meets your audience's needs. It also helps you avoid plagiarism, grammatical errors, spelling mistakes, and factual inaccuracies that might undermine your credibility and authority. Content development should follow the standards of plain language, active voice, parallelism, and transitions to create a logical and smooth flow.

添加您的观点

John Sanchez

? I help FP&A professionals accelerate their careers with LEVERAGED* training. * We leverage the 80/20 rule to focus on the 20% of skills that get you 80% of results
举报内容
The constant battle in content development is the quality/quantity balance. Quantity draws attention, but only if the content is high quality will you get people coming back for more. Maintaining high quality standards requires commitment and time, but it's well worth it.

已翻译

赞

4 Ethical considerations

Technical communication also requires ethical considerations. Ethical considerations refer to the moral and legal implications of your document, such as honesty, fairness, respect, and responsibility. Ethical considerations help you protect your reputation, comply with regulations, and avoid lawsuits or penalties. They also help you respect your audience's rights, privacy, and diversity. Ethical considerations should follow the codes of conduct, policies, and laws of your industry, organization, and profession.

添加您的观点

5 Accessibility and usability

Finally, technical communication should ensure accessibility and usability. Accessibility and usability refer to the ease and convenience of accessing and using your document, especially for people with disabilities or special needs. Accessibility and usability help you reach a wider and more inclusive audience, improve customer satisfaction and loyalty, and reduce errors and risks. They also help you comply with the standards and guidelines of the Web Content Accessibility Guidelines (WCAG) and the Americans with Disabilities Act (ADA). Accessibility and usability should follow the best practices of providing alternative text, captions, headings, landmarks, and keyboard navigation.

Technical communication standards are essential for creating effective and professional documents that serve your purpose and audience. By following these standards, you can improve your communication skills, enhance your career prospects, and contribute to your industry and society.

添加您的观点

6 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?

添加您的观点

Communication

+ 关注

给文章评分

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

很棒不太好

举报此文章

查看全部

What are the technical communication standards for industry?

1

2

3

4

5

6

1 Audience analysis

2 Document design

3 Content development

4 Ethical considerations

5 Accessibility and usability

6 Here’s what else to consider

Communication

给文章评分

感谢您的反馈

更多Communication相关文章

更多相关阅读内容

What are the technical communication standards for industry?

1

2

3

4

5

6

1 Audience analysis

2 Document design

3 Content development

4 Ethical considerations

5 Accessibility and usability

6 Here’s what else to consider

Communication

给文章评分

感谢您的反馈

查看其他技能