In trendy software program growth, agility shouldn’t be a matter of velocity — it’s about being adaptable, open, and constant. Whereas a lot of the eye in Agile growth is concentrated round iterations, sprints, and steady supply, documentation typically falls behind.
However what if the documentation may 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 Reality” philosophy that makes an attempt to deliver and solidify data 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 apply of writing and supporting documentation utilizing the identical processes and instruments which might be used for writing code.
As an alternative of storing technical content material in exterior methods similar to Phrase paperwork or wikis, Docs as Code shops all the things in a model management system, sometimes Git.
Which means that documentation:
- Lives in the identical repositories because the supply code.
- Is written in light-weight markup languages similar to Markdown or AsciiDoc.
- Follows the identical branching, pull request, and code evaluate workflows.
- Is built-in into the CI/CD pipeline, the place documentation may be mechanically 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, through the use of model management, each change to the documentation is tracked and may be rolled again if wanted, identical to with code.
Automation, in flip, helps simplify the method — builds, previews, and error checks occur independently, which implies much less work concerned and faster supply.
Additional, as a result of the identical instrument units are used when creating customized software program, collaboration is means 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 data in a one single location, which everyone on the group can discuss with.
It’s easy in Agile growth 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 mechanically is aware of about it.
By linking code and documentation collectively, groups keep away from duplication, scale 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 identical to the code, and by the identical folks.
Advantages of Documentation as Code in Agile Software program Improvement
Total, Documentation as Code possesses some compelling advantages in Agile growth, serving to groups work quicker, wiser, and with fewer misunderstandings.
First, it retains documentation updated. As a result of it’s being saved and stored with the code, any modifications may be carried out and reviewed without delay. No ready for an individual to revise a separate doc or wiki down the road.
Second, it improves teamwork. All of the individuals, 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 assessments to the CI/CD pipeline. They will mechanically discover damaged hyperlinks, misspellings, or out of date references within the docs, the identical means they will discover code.
Lastly, quite a few affluent corporations are already training this method. GitLab and Kubernetes initiatives have indicated that placing documentation into the event course of leads to extra secure, useful, and easier-to-use documentation.
The right way to Implement Documentation as Code
Getting Documentation as Code stay isn’t that tough, however it should take you to change the way in which your group operates. The very best recommendation right here is to begin small and steadily transfer towards making Docs as Code part of your course of.
1. Begin Small
To begin with, select a small challenge or a particular module to doc utilizing Docs as Code. This step permits your group 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 will have the correct instruments at hand. For model management, you’ll wish to use a system like Git (with GitHub, GitLab, or Bitbucket).
For writing the documentation itself, you should use easy markup languages, similar to Markdown, AsciiDoc, or reStructuredText.
Additional, take into account making use of static website 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) in an effort to auto-format checks, spelling checks, and deployment.
3. Incorporate Documentation into Your Workflow
When you will have the instruments arrange, it’s time to merge documentation into your growth workflow. Put merely, it means putting documentation modifications in the identical pipeline as code modifications.
If a developer creates code, they have 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 evaluate them identical to you’ll evaluate code modifications.
4. Educate Your Staff
In addition to, it’s essential to coach your group 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 group effort, not the only duty of 1 individual.
5. Keep away from Frequent Pitfalls
On the similar 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 complicated instruments or processes.
One other mistake is forgetting documentation after the preliminary setup is full. With the intention to hold your docs up-to-date, embody them within the CI/CD pipeline and encourage common evaluate. A quick reminder: when you hold documentation a low precedence, it should simply fall behind.
6. Undertake Steady Enchancment
Lastly, keep in mind that Docs as Code is a steady course of. The extra your group will get used to the workflow, the extra it is possible for you to to streamline and refine it much more.
You may, for example, add even higher automation, enhance the fashion, and even add person suggestions to additional improve the documentation. What is crucial is to deal with it as a long-term funding that pays off within the type of higher collaboration and a greater growth course of.
Challenges and Issues of Creating Documentation in Software program Improvement
One of many greatest challenges is to maintain the documentation updated when the code is being edited. To unravel this, there’s a must replace the documentation and likewise the code.
One other drawback is duplication. Programmers prefer to remark within the code how issues are achieved, and infrequently this repeats the documentation.
Whereas code feedback are essential, they have to give attention to technical particulars within the code, and the documentation ought to present clear, high-level data for customers.
Adopting Docs as Code additionally requires reworking how the group works, which may be difficult for people used to conventional documentation. A few of the group members would possibly resist at first, however with time, once they see the advantages, it turns into painless.
Although automation helps, it may’t do all the things. Instruments can seek for small errors, however they will’t inform if the documentation is unambiguous or useful. That takes human involvement. Reviewing the documentation regularly ensures that it’s precious and correct.
Lastly, as your challenge progresses, the system documentation can grow to be 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 can even hold all the things correct and true to life.
| Problem | Resolution |
| Retaining Documentation As much as Date | Replace code and documentation collectively. |
| Duplication of Data | Preserve code feedback technical; documentation ought to give attention to high-level data. |
| Adopting Docs as Code | Progressively transition, displaying 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 group 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 circumstances of corporations and initiatives which have efficiently enforced this technique.
The circumstances beneath research illustrate how Docs as Code aids in enhancing collaboration, sustaining related documentation, and making the event course of extra ample.
1. GitLab: A Chief in Docs as Code
GitLab, a well-known DevOps and CI/CD instrument, is a superb instance of an organization that has welcomed Documentation as Code.
Its docs are saved in the identical Git repository because the code, and the whole group works collectively to take care of it as much as the minute.
The corporate makes use of GitLab’s personal CI/CD pipeline to mechanically produce and deploy the documentation each time a change is pushed to the codebase.
Resulting from 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 drawback of documentation rising outdated or forgotten.
It additionally unites the whole group—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 one more nice instance of how Documentation as Code is practiced.
All person documentation and API references for Kubernetes are stored in the identical Git repository as their code. This means that each time the software program is being altered, it’s easy to replace the documentation too.
Additionally they make use of automation to verify 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: Retaining 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 group adjusts their API, they alter their documentation together with the code throughout the similar 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 data always.
The Function of Technical Writers in Docs as Code
Within the means of Docs as Code, technical writers have an especially essential place. Whereas the builders write down the technical data, technical writers double-check that such data shouldn’t be tough to learn, structured adequately, and straightforward to know for everybody.
Technical writers remodel tough technical language into components anybody can perceive, and that is particularly crucial in Agile initiatives 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 evaluate updates, gather solutions, and use automation instruments to catch small errors.
On the whole, technical writers fill the hole between the technical aspect of growth and the wants of customers, making the entire documentation course of a hit.
FAQ
What’s “Documentation as Code”?
Documentation as Code is a apply of writing and protecting documentation in the identical means builders write and hold code — by way of automation, Git, and model management. It retains the documentation up-to-date, reviewed, and versioned identical 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 crucial. They make the data 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?
Retaining code and documentation separate implies that each of them may be up to date on the similar time. It avoids stale data being utilized by groups and ensures customers get the most recent and most correct documentation on a regular basis.
