Software development has faced many challenges over the past few decades, and all too often technical documentation teams need to overcome similar hurdles. Which solutions have proved their worth over the years, and how can we apply them to documentation projects?
Docs as Code, as it is defined, refers to a philosophy that you should be writing documentation with the same tools and workflows as code. Although the workflows are of great importance here, if the documentation is for a software product, using the same tools as the developers can bring additional benefits, such as an increased willingness to collaborate. Also, chances are that the software team already has these processes set up, and it is therefore even easier and more logical to use the same tools and workflows for the documentation process. In my company, both software development and documentation teams are employing the same workflows and tools. A story is not complete until documented!
In this article, I will talk about what you need to take into account to implement a proper Docs-as-Code workflow.
Version control system
Does anyone remember those times when we kept multiple ...
Read more after login
tekom members can log in directly with their "My tekom" access data.
You are not yet a tekom member, but would like to read one or more articles in full? Then you have the opportunity to register on the internet portal of the technical journal 'tcworld' without obligation. Once you have registered, you can select any three specialist articles and view them in full for a period of two months. The selection will then be deleted and you can select three new articles for the next two months.
As a tekom member you benefit from the following advantages::
- Online access to all articles of the trade magazine 'tcworld magazine'
- Exclusive specialist articles from all areas of technical communication
- Regular new articles from over 300 authors
- The technical journal 'tcworld magazine' as a printed edition
- Reduced admission prices to tekom conferences
- Membership fees for tekom publications
- Access to 'my tekom', the web forum with job offers / job requests, appointments, expert advice, service provider file and much more
Promised: The trade magazine 'tcworld magazine' is the best we have. And we don't make the choice easy for ourselves. Every month, the editorial staff of the technical journal 'tcworld magazine' publishes the latest articles by renowned authors. This demanding selection is available exclusively to members of tekom (as usual, including the printed edition).
The trade magazine 'tcworld magazine' stands for intelligently prepared specialist articles, texts written to the point, informative content, surprising insights, international perspectives and communicates technical communication in an understandable, fast, clear and uncomplicated way - exclusively for you.