微软技术写作指南:全面实用的参考资源
需积分: 9 152 浏览量
更新于2024-07-17
收藏 3.14MB PDF 举报
Microsoft Writing Style Guide 是一份全面且内容丰富的技术写作指南,它为撰写微软官方文档提供了清晰的准则和实用建议。这份风格指南强调了简洁、人性化的核心理念,旨在确保所有技术文档的一致性和易读性。
首先,"Welcome"部分可能介绍了指南的目的,以及为何对于技术作者来说它是必不可少的工具。它可能强调了清晰沟通的重要性,特别是在技术领域,读者通常需要迅速理解复杂的概念和技术细节。
"Top 10 tips for Microsoft style and voice" 部分则是具体的操作指南,可能包含如何保持一致的品牌语言风格,如使用简单直接的语言,避免行话和术语过重,以及如何有效地组织和呈现信息。这些建议可能是针对词汇选择、句子结构、段落布局等方面,帮助作者构建易于理解的文章。
"A-Z word list and term collections" 提供了一个详尽的词汇表,涵盖了各种专业术语。例如,"Accessibility terms" 部分可能包括与无障碍设计和可访问性相关的词汇,确保文档对所有用户友好;"Bits and by testerms" 可能涉及计算机硬件和网络术语;"Bot terms" 关注于人工智能和自动化领域的词汇;"Cloud-computing terms" 则涵盖了云计算的常用术语;此外还有"Computer and device terms"、"Date and time terms"、"Keys and keyboard shortcuts" 等,分别处理了与计算机操作、时间表示和快捷键相关的术语。
在"Numbers and symbols" 部分,作者可能会提供关于数字和符号使用的标准,比如 "24/7" 表示全天候服务,"2D, two-dimensional" 和 "3D, three-dimensional" 描述维度,而 "8.5"×"11" paper 指的是纸张尺寸。特殊字符的使用,如 "ampersand(&)",也会在此列出并解释其在文档中的用法。
"Argument vs. parameter" 这一节可能会区分编程中的参数和函数调用中的参数,帮助作者准确地传达代码逻辑。箭头符号的使用规范,比如 "arrow",则确保一致性。
此外,还有针对鼠标交互、安全术语、触控和笔交互以及单位量度的标准定义,这些都是技术文档中不容忽视的部分,因为它们直接影响到用户的理解和操作体验。
总结来说,Microsoft Writing Style Guide 是一个全面的指南,不仅关注语言风格和词汇使用,还涵盖了一系列与技术文档编写相关的细节,确保技术信息传递的专业性和易读性,是任何技术作者提升文档质量的重要参考资料。
2009-11-17 上传
2023-06-11 上传
2023-06-11 上传
2023-02-14 上传
2023-05-27 上传
2024-12-25 上传