This relatively new method of documentation is taking the technical writers world to a whole new level. You can say that I’m a bit late to the game but you’ve got to start somewhere right?
Summary
- Developers and writers utilize the same tool for coding and content creation
Advantages
- Documentation and software can be coordinated and released in tandem
- Allows for collaboration between developers and technical writers
- Enables simultaneous development of documentation and code.
- Scripts can be used to automate workflow
- Use markup code for standardization
- Redundant text can be codified and repeated
- Reduces need for technical writers (this could be considered a disadvantage as well!)
- Enables consistency across platforms
Disadvantages
- Requires basic familiarity of developer tools for technical writers
- Best used when documenting code (may not be applicable for all types of documentation)
- Reduces the need for technical writers