EdX Style Guide
1. Introduction
2. Preferred Usage
3. Word List
4. Documenting User Interface Interactions
4.1. List of edX UI Elements
4.2. Standards for User Interface Labels
5. Topic Templates
5.1. Writing Concept Topics
5.1.1. Structuring a Concept Topic
5.1.2. Example Concept Topics
5.2. {Using this Concept Template}
5.2.1. {Optional Overview}
5.2.2. {Optional Procedure}
5.3. Writing Task Topics
5.3.1. Structuring a Task Topic
5.3.2. Example Task Topics
5.4. {Using This Task Template}
5.4.1. {Title: Imperative a Noun}
6. Style Conventions and Content Layout
7. Images
7.1. Resources
7.2. Guidelines for Adding Images
7.2.1. Messages
7.2.2. Colors
7.2.3. Browser Width
7.3. Capturing Screen Shots
7.4. Editing Images
7.4.1. SnagIt Style Gallery
7.4.2. Borders
7.4.3. File Size and Format
7.4.4. Annotations
7.5. Adding an Image to a File
7.5.1. Alt Text for Accessibility
7.5.2. Image Sizes
8. Guidelines for Writing Global English
8.1. Global Examples
8.2. Short Sentences
8.3. Active Voice and Active Verbs
8.4. Bulleted Lists
8.5. Pronouns
8.6. Mood
8.7. Provide Context
8.8. Word Choice
8.9. Use (and Add to) the Glossary
8.10. Contractions
8.11. White Space
8.12. Punctuation
8.13. Abbreviations
8.14. References to Explore
9. Media Accessibility
9.1. Introduction
9.2. Blindness
9.2.1. Things to Keep in Mind
9.2.2. How These Techniques Can Benefit a Broader Audience
9.3. Low Vision
9.3.1. Things to Keep in Mind
9.3.2. How These Techniques Can Benefit a Broader Audience
9.4. Deafness
9.4.1. Things to Keep in Mind
9.4.2. How These Techniques Can Benefit a Broader Audience
9.5. Hard of Hearing
9.5.1. Things to Keep in Mind
9.6. WCAG 2 AA Requirements for Media
9.6.1. Principle 1: Perceivable
9.7. Audio Description
10. Working with edX Documentation Source Files
10.1. Documentation Tools and Processes
10.2. Basic Formatting In .rst Files
10.2.1. Alignment
10.2.2. Headings
10.2.3. Lists
10.2.4. Comments
10.2.5. Special Tags
10.2.6. Image Links
10.2.7. Tables
10.2.8. Anchors and Internal Links
10.2.9. Code Examples
10.2.10. Other Text Styles
11. Guidelines for Translators
11.1. What to Translate
11.2. What Not to Translate
12. Documentation Translation Process
13. Example .rst File
13.1. Heading Levels
13.2. Paragraph Text and Commented Text
13.3. Ordered and Unordered Lists
13.3.1. Nested Lists or Content
13.4. Conditional Text
13.5. Notes and Warnings
13.6. Cross-References
13.6.1. Cross-References to Locations in the Same Document
13.6.2. Cross-References to Locations in Different edX Documents
13.6.3. Cross-References to JIRA
13.6.4. Cross-References to External Web Pages
13.7. Image References
13.8. Tables
13.8.1. Example of a table with an empty cell
13.8.2. Example of a table with a header row
13.8.3. Example of a table with a boldface first column
13.8.4. Example of a table with a cell that includes an unordered list
13.9. Code Formatting
13.9.1. Inline code
13.9.2. Code blocks
14. Glossary
14.1. A
14.2. C
14.3. D
14.4. E
14.5. F
14.6. G
14.7. H
14.8. I
14.9. K
14.10. L
14.11. M
14.12. N
14.13. O
14.14. P
14.15. Q
14.16. R
14.17. S
14.18. T
14.19. U
14.20. V
14.21. W
14.22. XYZ
EdX Style Guide
Table of Contents
»
5.
Topic Templates
Give Doc Feedback
Edit on GitHub
5.
Topic Templates
ΒΆ
5.1. Writing Concept Topics
5.1.1. Structuring a Concept Topic
5.1.2. Example Concept Topics
5.2. {Using this Concept Template}
5.2.1. {Optional Overview}
5.2.2. {Optional Procedure}
5.3. Writing Task Topics
5.3.1. Structuring a Task Topic
5.3.2. Example Task Topics
5.4. {Using This Task Template}
5.4.1. {Title: Imperative a Noun}