This document discusses various techniques for automating and improving technical documentation processes, including spelling checking with Hunspell and markdown-spellcheck, writing better with write-good and LanguageTool, adding screenshots with Robot Framework and Selenium, testing with APIs like Dredd and Sphinx, using Pandoc for multiformat output, and placeholders with sed. It encourages automating documentation work and testing to ensure documentation quality and usability.
24. Editor snippets
• Atom: Built in
• Vim: ultisnips, snipmate, xtemplate and
more
• Emacs: Yasnippet
• Sublime: Built in
25. Placeholders - sed
if [[ $2 == "preview" ]]; then
sed -i -e 's/<access_token>/
46cc338e0d4647e3b9f98c52615a2414d725b6ddffdbbb2
f3bed26f73789dd53/g' $result_string
else
sed -i -e 's/<access_token>/
297e67b247c1a77c1a23bb33bf4c32b81500519edd767a8
384a4b8f8803fb971/g' $result_string
fi