A style guide saves documentarians time and trouble by providing a single reference for writing about common topics, features, and more. It can provide guidelines for different documentation deliverables, such as API reference manuals, tutorials, release notes, or overviews of complex technical concepts Multiple Styles and Formats. Print Resources. The Manual of Scientific Style: A Guide for Authors, Editors, and Researchers -- Hunt Library Stacks TM Cite Them Right: The Essential Referencing Guide -- D. H. Hill Jr. Library Stacks: PNF56 P43 Making Sense: A Student’s Guide to Research and Writing -- D. H. Hill Jr. Stacks: LBN67 Documentation Style Guide This document defines the standards for GitLab documentation, including grammar, formatting, word use, and more. For style questions, mention @tw-style in an issue or merge request. If you have access to the GitLab Slack workspace, use the #docs-processes blogger.com variable: Li8j-mLUVA3eZYjPfd_H
About this guide | Google developer documentation style guide
This style guide provides editorial guidelines for writing clear and consistent Google-related developer documentation, documentation style guide. If you're new to the guide and looking for introductory topics about our style, then start with HighlightsVoice and toneand Text-formatting summary, documentation style guide. Otherwise, use the guide as a reference document for specific questions. For example, you can look up terms in the word list.
This style documentation style guide. If project-specific style guidelines don't provide explicit guidance, then follow documentation style guide guide.
You can use additional resources to research and inform your thinking, but don't consider them part of Google developer documentation style. For guidance that applies only to Android or Google Cloud documentation, look for the following logos:.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4. For details, see the Google Developers Site Policies. Key resources. General principles. Language and grammar. Formatting and organization.
Computer interfaces. HTML and CSS, documentation style guide. Names and naming. Editorial resources We recommend using the following editorial resources. Reference hierarchy Use the following references, including this guide, in this order: Project-specific style. Follow style guidance specific to your project or product, such as necessary exceptions to this guide or terms that are relevant only to your product.
Documentation style guide references. If the preceding references don't provide explicit guidance, then see these third-party references, depending on the nature of your question: Type of question Third-party reference Spelling Follow Merriam-Webster. See also Spelling. Nontechnical style Follow The Chicago Manual of Style17th edition subscription documentation style guide. Technical style See the Microsoft Writing Style Guide.
But consider whether Microsoft's guidance applies; some of it might apply only to Microsoft products and interfaces. Other editorial resources You can use additional resources to research and inform your thinking, documentation style guide, but don't consider them part of Google developer documentation style. Here are some other style guides from the tech community: Apple Style Guide Red Hat technical documentation style guide Annotations used in this guide For guidance that applies only to Android or Google Cloud documentation, look for the following logos: precedes terms and guidelines specific to Android documentation.
precedes terms and guidelines specific to Google Cloud documentation. Breaking the rules Break any of these rules sooner than say anything outright barbarous. Depart from it when doing so improves your content. Android Chrome Firebase Google Cloud Platform All products Terms Privacy Sign up for the Google Developers newsletter Subscribe Language English Bahasa Indonesia Deutsch Español Français Português — Brasil Русский 中文 — 简体 日本語 한국어.
Follow Merriam-Webster. Follow The Chicago Manual of Style17th edition subscription required. See the Microsoft Writing Style Guide.
How to Write in APA Style
, time: 8:45Documentation Styles: Writing Resources Guide | NC State University Libraries
A style guide saves documentarians time and trouble by providing a single reference for writing about common topics, features, and more. It can provide guidelines for different documentation deliverables, such as API reference manuals, tutorials, release notes, or overviews of complex technical concepts Multiple Styles and Formats. Print Resources. The Manual of Scientific Style: A Guide for Authors, Editors, and Researchers -- Hunt Library Stacks TM Cite Them Right: The Essential Referencing Guide -- D. H. Hill Jr. Library Stacks: PNF56 P43 Making Sense: A Student’s Guide to Research and Writing -- D. H. Hill Jr. Stacks: LBN67 Documentation Style Guide This document defines the standards for GitLab documentation, including grammar, formatting, word use, and more. For style questions, mention @tw-style in an issue or merge request. If you have access to the GitLab Slack workspace, use the #docs-processes blogger.com variable: Li8j-mLUVA3eZYjPfd_H
No comments:
Post a Comment