In fashionable software program improvement, agility isn’t a matter of velocity — it’s about being adaptable, open, and constant. Whereas a lot of the eye in Agile improvement is concentrated round iterations, sprints, and steady supply, documentation typically falls behind.
However what if the documentation might sustain with the code? That’s precisely what Documentation as Code is about.
At its coronary heart, this method treats documentation like software program code: it’s versioned, re-inspected, examined, and deployed utilizing the identical instruments and workflows.
This idea is in actual alignment with the “Single Supply of Fact” philosophy that makes an attempt to carry and solidify info collectively in a undertaking so it doesn’t create confusion, redundancy, and miscommunication.
Let’s dive into what Documentation as Code (Docs as Code) is and the way it allows this philosophy in Agile settings.
What Is Documentation as Code?
Documentation as Code refers back to the follow of writing and supporting documentation utilizing the identical processes and instruments which can be used for writing code.
As an alternative of storing technical content material in exterior methods equivalent to Phrase paperwork or wikis, Docs as Code shops all the things in a model management system, usually Git.
Which means documentation:
- Lives in the identical repositories because the supply code.
- Is written in light-weight markup languages equivalent to Markdown or AsciiDoc.
- Follows the identical branching, pull request, and code assessment workflows.
- Is built-in into the CI/CD pipeline, the place documentation might be routinely linted, examined, and deployed.
The important thing ideas of the Documentation as Code philosophy collaborate with each other to maintain documentation exact, up-to-date, and simple to control.
To start with, by utilizing model management, each change to the documentation is tracked and might be rolled again if wanted, similar to with code.
Automation, in flip, helps simplify the method — builds, previews, and error checks occur independently, which suggests much less work concerned and faster supply.
Additional, as a result of the identical software units are used when growing customized software program, collaboration is means simpler. Builders, product managers, and technical writers may even contribute based on established workflows.
The One Supply of Fact Philosophy
One Supply of Fact implies having info in a one single location, which everyone on the workforce can confer with.
It’s easy in Agile improvement to have the documentation get unruly — there might be a few of it on wikis, some on shared drives, and a few buried in outdated electronic mail threads.
With Documentation as Code, in flip, the Single Supply of Fact turns into the codebase itself. The documentation exists alongside the code, in the identical model management repository, and makes use of the identical workflow.
Put merely, any alteration to the code might be adopted by the matching documentation replace and everybody routinely is aware of about it.
By linking code and documentation collectively, groups keep away from duplication, cut back errors, and facilitate communication. This manner, it’s a lot simpler to belief documentation — as a result of it will get up to date similar to the code, and by the identical individuals.
Advantages of Documentation as Code in Agile Software program Growth
Total, Documentation as Code possesses some compelling advantages in Agile improvement, serving to groups work sooner, wiser, and with fewer misunderstandings.
First, it retains documentation updated. As a result of it’s being saved and saved with the code, any modifications might be carried out and reviewed directly. No ready for an individual to revise a separate doc or wiki down the road.
Second, it improves teamwork. All of the members, from builders and testers to writers and product managers, can contribute to the documentation utilizing the identical instruments they use to code.
Third, it impacts the code’s high quality. Writing and validating technical documentation concurrently with code forces builders to pay extra consideration to how their code behaves, which tends to result in a greater design with fewer bugs.
Fourth, builders can add automated checks and exams to the CI/CD pipeline. They’ll routinely discover damaged hyperlinks, misspellings, or out of date references within the docs, the identical means they’ll discover code.
Lastly, quite a few affluent corporations are already working towards this method. GitLab and Kubernetes tasks have indicated that placing documentation into the event course of ends in extra secure, useful, and easier-to-use documentation.
Implement Documentation as Code
Getting Documentation as Code reside isn’t that troublesome, however it’ll take you to change the best way your workforce operates. The very best recommendation right here is to begin small and regularly transfer towards making Docs as Code part of your course of.
1. Begin Small
To start with, select a small undertaking or a particular module to doc utilizing Docs as Code. This step permits your workforce to get aware of the method with out feeling overwhelmed.
Then write documentation for one or two options or elements and retailer it in the identical Git repository as your code. This manner, you’ll get a really feel for the way documentation might be handled like code.
2. Use the Proper Instruments
Subsequent, double-check you might have the suitable instruments at hand. For model management, you’ll need to use a system like Git (with GitHub, GitLab, or Bitbucket).
For writing the documentation itself, you should use easy markup languages, equivalent to Markdown, AsciiDoc, or reStructuredText.
Additional, contemplate making use of static web site turbines like MkDocs, Docusaurus, or Hugo to show your Markdown recordsdata into knowledgeable, user-oriented documentation web site.
Lastly, combine your documentation into your CI/CD pipeline (e.g., GitHub Actions, GitLab CI, or CircleCI) with a purpose to auto-format checks, spelling checks, and deployment.
3. Incorporate Documentation into Your Workflow
When you might have the instruments arrange, it’s time to merge documentation into your improvement workflow. Put merely, it means inserting documentation adjustments in the identical pipeline as code adjustments.
If a developer creates code, they have to additionally replace or add the respective documentation in the identical commit. To maintain all of the elements organized, it’s essential to create pull requests for documentation adjustments and assessment them similar to you’d assessment code adjustments.
4. Educate Your Group
Apart from, it’s essential to coach your workforce on how Docs as Code works. This implies explaining the instruments you’ll use, the workflows, and the advantages of getting documentation in model management.
Have interaction builders, product managers, and technical writers to play lively roles in including to documentation. Collective duty will make documentation a workforce effort, not the only duty of 1 particular person.
5. Keep away from Widespread Pitfalls
On the identical time, watch out to not fall into frequent traps when going Docs as Code. One mistake to keep away from is over-engineering the documentation course of on the onset. As an alternative, simplify issues first after which add more and more extra advanced instruments or processes.
One other mistake is forgetting documentation after the preliminary setup is full. With a view to hold your docs up-to-date, embody them within the CI/CD pipeline and encourage common assessment. A short reminder: when you hold documentation a low precedence, it’ll simply fall behind.
6. Undertake Steady Enchancment
Lastly, do not forget that Docs as Code is a steady course of. The extra your workforce will get used to the workflow, the extra it is possible for you to to streamline and refine it much more.
You possibly can, as an example, add even better automation, enhance the fashion, and even add person suggestions to additional improve the documentation. What is important is to deal with it as a long-term funding that pays off within the type of higher collaboration and a greater improvement course of.
Challenges and Issues of Creating Documentation in Software program Growth
One of many largest challenges is to maintain the documentation updated when the code is being edited. To unravel this, there’s a have to replace the documentation and in addition the code.
One other drawback is duplication. Programmers wish to remark within the code how issues are completed, and sometimes this repeats the documentation.
Whereas code feedback are essential, they have to deal with technical particulars within the code, and the documentation ought to present clear, high-level info for customers.
Adopting Docs as Code additionally requires remodeling how the workforce works, which might be difficult for people used to conventional documentation. A number of the workforce members may resist at first, however with time, after they see the advantages, it turns into painless.
Regardless that automation helps, it may well’t do all the things. Instruments can seek for small errors, however they’ll’t inform if the documentation is unambiguous or useful. That takes human involvement. Reviewing the documentation regularly ensures that it’s worthwhile and correct.
Lastly, as your undertaking progresses, the system documentation can change into outdated or disconnected from the place the product is. To stop this, it’s essential to have opinions and updates regularly.
Having an individual who has the duty of maintaining a tally of particular areas of the documentation may hold all the things correct and true to life.
| Problem | Resolution |
| Maintaining Documentation As much as Date | Replace code and documentation collectively. |
| Duplication of Data | Hold code feedback technical; documentation ought to deal with high-level data. |
| Adopting Docs as Code | Steadily transition, exhibiting advantages over time. |
| Automation Limitations | Common human opinions to make sure readability and accuracy. |
| Outdated Documentation | Common opinions and updates to align with the most recent product model. |
| Lack of Possession | Assign workforce members to supervise particular areas of documentation. |
Actual-World Use Circumstances of Leveraging Software program Documentation
To get an concept of how Documentation as Code operates in precise environments, let’s analyze some use circumstances of corporations and tasks which have efficiently enforced this technique.
The circumstances under research illustrate how Docs as Code aids in bettering collaboration, sustaining related documentation, and making the event course of extra enough.
1. GitLab: A Chief in Docs as Code
GitLab, a well-known DevOps and CI/CD software, is a good instance of an organization that has welcomed Documentation as Code.
Its docs are saved in the identical Git repository because the code, and your complete workforce works collectively to keep up it as much as the minute.
The corporate makes use of GitLab’s personal CI/CD pipeline to routinely produce and deploy the documentation every time a change is pushed to the codebase.
As a consequence of such an association, all undertaking members can simply entry and leverage the documentation. And since it’s a part of the event course of, GitLab sidesteps the basic drawback of documentation rising outdated or forgotten.
It additionally unites your complete workforce—builders, technical writers, and everybody else can contribute to the documentation in the identical means they contribute to the code.
2. Kubernetes: Open Supply Success
Kubernetes is yet one more nice instance of how Documentation as Code is practiced.
All person documentation and API references for Kubernetes are saved in the identical Git repository as their code. This means that every time the software program is being altered, it’s easy to replace the documentation too.
Additionally they make use of automation to examine for issues like hyperlink breaks or out of date code examples.
Total, due to this course of, a lot of contributors constantly refine the code and documentation at common intervals, guaranteeing that each piece of labor is present and reliable.
3. Stripe: Maintaining Documentation in Sync with Code
Stripe, a longtime cost firm, additionally makes use of Documentation as Code to maintain its API documentation updated.
As their workforce adjusts their API, they alter their documentation together with the code inside the identical Git repository. This manner, all edits are immediately mirrored within the official docs.
By together with documentation in the identical course of as coding, Stripe avoids the inconvenience of sustaining separate documentation and supplies customers with the most recent and finest info always.
The Function of Technical Writers in Docs as Code
Within the means of Docs as Code, technical writers have a particularly essential place. Whereas the builders write down the technical info, technical writers double-check that such info isn’t troublesome to learn, structured adequately, and simple to know for everybody.
Technical writers rework difficult technical language into elements anybody can perceive, and that is particularly important in Agile tasks the place each software program and documentation get developed hand-in-hand.
Technical writers additionally work with builders, utilizing the identical Git repository in order that the documentation is all the time updated with the most recent code.
Their information makes the documentation correct, well-organized, and useful. They assessment updates, accumulate options, and use automation instruments to catch small errors.
Generally, technical writers fill the hole between the technical facet of improvement and the wants of customers, making the entire documentation course of successful.
FAQ
What’s “Documentation as Code”?
Documentation as Code is a follow of writing and conserving documentation in the identical means builders write and hold code — by means of automation, Git, and model management. It retains the documentation up-to-date, reviewed, and versioned similar to the software program itself.
Do builders write all of the documentation in Docs as Code?
Not essentially. Whereas builders will contribute, technical writers are nonetheless mandatory. They make the knowledge properly organized, readable, and clear to customers, even when it’s written in a code repository.
Why is it essential to hold documentation in the identical Git repository as code?
Maintaining code and documentation separate signifies that each of them might be up to date on the identical time. It avoids stale info being utilized by groups and ensures customers get the most recent and most correct documentation on a regular basis.