10 docs tagged with "documentation"

In this section, you will find guidelines for using standard formatting codes correctly. Follow these recommendations and avoid common errors and make your content assertive.

On this section, you will understand how to document command-line commands and their respective arguments.

This content style guide provides guidelines and standards for creating and maintaining consistent and cohesive Bucketeer developer content.

This section covers a range of elements that contribute to your content's overall structure and presentation. By following these guidelines, you will ensure your content is well-organized, visually appealing, and consistent.

Within this section on language and grammar, you will discover the primary information and guidelines to navigate the complexities of grammar. From abbreviations and active voice to sentence structure and contractions, we've compiled a set of standards to make your writing clear, concise, and easily understandable.

When writing link text, it's best to use brief yet descriptive phrases that offer an idea of the content you're linking to.

This page provides the content style guide for contributing with documentation.

It's essential to use proper punctuation marks to ensure your message is clear and understandable. This section will provide the correct usage and guidelines for the most common types of punctuation and help you avoid common mistakes.

Instead of focusing on the widgets and gestures, it is better to state instructions in terms of what the user should accomplish. This approach helps the user understand the purpose of the instruction and future-proof procedures by avoiding reference to UI elements.

It is essential to be aware of the following aspects of voice and tone: