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 strategy 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 Reality” philosophy that makes an attempt to carry and solidify info collectively in a challenge 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 permits 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 techniques corresponding to Phrase paperwork or wikis, Docs as Code shops the whole lot in a model management system, sometimes Git.
Which means documentation:
- Lives in the identical repositories because the supply code.
- Is written in light-weight markup languages corresponding to Markdown or AsciiDoc.
- Follows the identical branching, pull request, and code evaluation workflows.
- Is built-in into the CI/CD pipeline, the place documentation may 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 straightforward to manipulate.
To start with, by utilizing model management, each change to the documentation is tracked and may 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 instrument units are used when growing customized software program, collaboration is manner simpler. Builders, product managers, and technical writers may even contribute in accordance with established workflows.
The One Supply of Reality Philosophy
One Supply of Reality implies having info in a one single location, which all people on the crew can confer with.
It’s easy in Agile improvement to have the documentation get unruly — there may 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 Reality 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 may 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 fashion, 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 quicker, 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 may 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 contributors, 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 will routinely discover damaged hyperlinks, misspellings, or out of date references within the docs, the identical manner they’ll discover code.
Lastly, quite a few affluent corporations are already practising this strategy. GitLab and Kubernetes tasks have indicated that placing documentation into the event course of ends in extra secure, useful, and easier-to-use documentation.
Methods to Implement Documentation as Code
Getting Documentation as Code dwell isn’t that tough, however it should take you to change the way in which your crew operates. One of the best recommendation right here is to begin small and step by step transfer towards making Docs as Code part of your course of.
1. Begin Small
Initially, select a small challenge or a particular module to doc utilizing Docs as Code. This step permits your crew to get acquainted with the method with out feeling overwhelmed.
Then write documentation for one or two options or parts and retailer it in the identical Git repository as your code. This fashion, you’ll get a really feel for the way documentation may be handled like code.
2. Use the Proper Instruments
Subsequent, double-check you have got the precise 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 utilize easy markup languages, corresponding to Markdown, AsciiDoc, or reStructuredText.
Additional, take into account making use of static website turbines like MkDocs, Docusaurus, or Hugo to show your Markdown information into knowledgeable, user-oriented documentation web site.
Lastly, combine your documentation into your CI/CD pipeline (e.g., GitHub Actions, GitLab CI, or CircleCI) in an effort to auto-format checks, spelling checks, and deployment.
3. Incorporate Documentation into Your Workflow
When you have got the instruments arrange, it’s time to merge documentation into your improvement workflow. Put merely, it means inserting documentation modifications in the identical pipeline as code modifications.
If a developer creates code, they need to additionally replace or add the respective documentation in the identical commit. To maintain all of the components organized, it’s essential to create pull requests for documentation modifications and evaluation them similar to you’d evaluation code modifications.
4. Educate Your Staff
Apart from, it’s vital to teach your crew 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 energetic roles in including to documentation. Collective duty will make documentation a crew effort, not the only duty of 1 individual.
5. Keep away from Widespread Pitfalls
On the identical time, watch out to not fall into widespread 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 the intention to preserve your docs up-to-date, embody them within the CI/CD pipeline and encourage common evaluation. A quick reminder: in the event you preserve documentation a low precedence, it should simply fall behind.
6. Undertake Steady Enchancment
Lastly, do not forget that Docs as Code is a steady course of. The extra your crew will get used to the workflow, the extra it is possible for you to to streamline and refine it much more.
You may, as an illustration, add even better automation, enhance the model, and even add consumer 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 Concerns of Creating Documentation in Software program Growth
One of many greatest challenges is to maintain the documentation updated when the code is being edited. To resolve this, there’s a must replace the documentation and likewise the code.
One other downside is duplication. Programmers wish to remark within the code how issues are completed, and infrequently this repeats the documentation.
Whereas code feedback are vital, they need to give attention to technical particulars within the code, and the documentation ought to present clear, high-level info for customers.
Adopting Docs as Code additionally requires reworking how the crew works, which may be difficult for people used to conventional documentation. A number of the crew members may resist at first, however with time, once they see the advantages, it turns into painless.
Though automation helps, it could possibly’t do the whole lot. 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 frequently ensures that it’s priceless and correct.
Lastly, as your challenge progresses, the system documentation can change into outdated or disconnected from the place the product is. To stop this, it’s vital to have critiques and updates frequently.
Having an individual who has the duty of keeping track of particular areas of the documentation can even preserve the whole lot correct and true to life.
| Problem | Resolution |
| Maintaining Documentation As much as Date | Replace code and documentation collectively. |
| Duplication of Info | Preserve code feedback technical; documentation ought to give attention to high-level data. |
| Adopting Docs as Code | Step by step transition, displaying advantages over time. |
| Automation Limitations | Common human critiques to make sure readability and accuracy. |
| Outdated Documentation | Common critiques and updates to align with the most recent product model. |
| Lack of Possession | Assign crew members to supervise particular areas of documentation. |
Actual-World Use Instances of Leveraging Software program Documentation
To get an concept of how Documentation as Code operates in precise environments, let’s analyze some use instances of corporations and tasks which have efficiently enforced this technique.
The instances beneath research illustrate how Docs as Code aids in bettering collaboration, sustaining related documentation, and making the event course of extra sufficient.
1. GitLab: A Chief in Docs as Code
GitLab, a well-known DevOps and CI/CD instrument, 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 crew works collectively to take care of it as much as the minute.
The corporate makes use of GitLab’s personal CI/CD pipeline to routinely produce and deploy the documentation at any time when a change is pushed to the codebase.
As a consequence of such an association, all challenge members can simply entry and leverage the documentation. And since it’s a part of the event course of, GitLab sidesteps the traditional downside of documentation rising outdated or forgotten.
It additionally unites your complete crew—builders, technical writers, and everybody else can contribute to the documentation in the identical manner they contribute to the code.
2. Kubernetes: Open Supply Success
Kubernetes is one more nice instance of how Documentation as Code is practiced.
All consumer documentation and API references for Kubernetes are saved in the identical Git repository as their code. This means that at any time when the software program is being altered, it’s easy to replace the documentation too.
Additionally they make use of automation to test for issues like hyperlink breaks or out of date code examples.
Total, because of 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 crew adjusts their API, they alter their documentation together with the code throughout the identical Git repository. This fashion, 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 gives customers with the most recent and greatest info always.
The Function of Technical Writers in Docs as Code
Within the strategy of Docs as Code, technical writers have a particularly vital place. Whereas the builders write down the technical info, technical writers double-check that such info isn’t tough to learn, structured adequately, and straightforward to understand for everybody.
Technical writers remodel tough technical language into components anybody can perceive, and that is particularly essential 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 at all times updated with the most recent code.
Their information makes the documentation correct, well-organized, and useful. They evaluation updates, accumulate strategies, and use automation instruments to catch small errors.
Basically, technical writers fill the hole between the technical facet of improvement and the wants of customers, making the entire documentation course of a hit.
FAQ
What’s “Documentation as Code”?
Documentation as Code is a follow of writing and preserving documentation in the identical manner builders write and preserve 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 vital. 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 preserve documentation in the identical Git repository as code?
Maintaining code and documentation separate implies that each of them may 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.
