All notable changes to the Nordic Semiconductor Technical Documentation Style Guide are documented in this file.
The format is based on Keep a Changelog.
- Added proper noun identification guidelines with article test
- Added structural document references (Chapter, Section, Table, Example capitalization rules)
- Added multi-volume documentation capitalization (Part I, Part II)
- Added page number formatting guidelines
- Added illustration labels and callouts capitalization
- Added input device controls capitalization (keyboard keys, buttons, switches)
- Added technical notation guidelines (hexadecimal, architecture, dimensions)
- Added variables and placeholders formatting rules
- Added physical component labels guidelines
- Added emphasis methods section
- Added guidance on spelling out contractions for critical instructions
- Added apostrophe ambiguity guidelines (possessive vs contraction)
- Added "it's" vs "its" confusion prevention
- Added regional and nonstandard contractions to avoid
- Added subject-verb agreement rules for contractions
- Expanded from 13 to 109 lines with comprehensive guidance
- Added "Understanding dual-meaning problems" section
- Added solutions for -ing word ambiguity (5 strategies)
- Added practical guidelines for headings, procedures, descriptions, and warnings
- Added industry specifications exception for numerals
- Added technical specifications with numeric values section
- Expanded fractions and decimals guidance with 4 subsections:
- Positioning fractional components
- Choosing between fractional and decimal formats
- Symbol versus written form
- Plural forms with fractional quantities
- Added pronoun reference distance section
- Added reading flow test for evaluating pronoun clarity
- Added techniques to strengthen weak pronoun links
- Added guidance for paragraph and section boundaries
- Added demonstrative pronouns in technical contexts
- Added ownership pronouns in hardware descriptions
- Added technical review checklist
- Added direct expression over abbreviated Latin (for example, specifically, and so on)
- Added navigation-aware term definitions for modular content
- Added preventing word-form confusion with punctuation
- Added density versus clarity optimization for tables and diagrams
- Added proper notation versus keyboard approximations
- Added measurement system bridging strategies
- Added temporal interval formatting guidelines
- Added industry convention conflicts guidance
- Created new Parentheses file.
- Added apostrophe rules for inanimate objects, compound constructions, joint/individual ownership, and letter plurals
- Added "Common colon misuses" section with error-pattern teaching
- Added en dash usage for list term separators
- Added en dash usage for reference numbering (Figure, Table, Example)
- Added nonbreaking hyphens section with guidance for key combinations, product identifiers, and technical compounds
- Added technical terminology guidance (periods as "dots")
- Added current directory notation for Unix-like systems
- Added "Don't use quotation marks" section for commands and technical elements
- Added guidance to use code formatting instead of quotation marks for literal text
- Added conjunctive adverb usage guidance
- Added "Rewrite complex semicolon lists" section with conversion examples
- Added "Why slashes create translation challenges" section explaining multiple meanings
- Replaced generic examples with Nordic-specific technical examples:
- Firmware signature verification
- MCU initialization
- Status LED behavior
- nRF Connect SDK features
- Nordic Semiconductor contact information
- SoC descriptions
- ISO 8601 timestamp formatting
- Initial fork of Nordic Technical Documentation Style Guide
- Base documentation structure with comprehensive style guidance
- Grammar, punctuation, and content structure guidelines
- Planning and procedures documentation
- Writing tips and bias-free communication guidance