Tooling ideas
These scripts explore some ideas around documentation tooling.
docs-as-code
Automatically propagate UI text changes to documentation.
Keep your technical documentation always in sync with UI changes. Pull the text of UI labels, hints, error messages, menu options, and so on from code and use them in your documentation as variables, so that when you build your techdoc pages, they are automatically updated with the code changes.
linkchecker-third-twin
Scan a directory recursively to identify duplicate, triplicate, or n-cate topic-to-topic links in DITA files.
Find the links that occur more than once in any DITA topic file. A link might have been inserted manually as an xref or related-links tag, or generated automatically during the DITA build through the collection type attribute or a reltable entry. This tool reports the cross-references that occur more than once. Relationship tables, topicref collections, inline cross-references, and links in the related-links tag are all reckoned.
orphan-scan
Identify files that are not referenced by any DITA file in a specified directory, recursively.
Maybe you have several image files, topic files, and other files in the directory but hesitate to delete them because you are not sure if any of these files are referenced by the DITA files in that directory. This tool scans the directory you specify and gives you a report that you can read and act upon to clean up your workspace.
word-list-scan
Scan all DITA files in a directory recursively for occurences of an entire list of words and phrases.
Maybe these words are a list of do-not-use words that your style guide specifies, but you don’t have an automated word checker to look for such occurences. Maybe you want to know if you’ve used certain DITA tags in your files but do not want to run a system search for each tag, one by one.
jekyll-github-starter-pack
Build a website in minutes on GitHub by using Jekyll’s support of Liquid variables and templates.
No, you don’t need to know either Jekyll or Liquid to get started. Once you’ve taken off with this starter pack, though, you’ll learn as much as you need to along the way.
