In fashionable 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 Fact” philosophy that makes an attempt to convey and solidify info collectively in a venture 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 observe of writing and supporting documentation utilizing the identical processes and instruments which can be used for writing code.
As a substitute of storing technical content material in exterior methods reminiscent of Phrase paperwork or wikis, Docs as Code shops the whole lot in a model management system, usually Git.
Which means that documentation:
- Lives in the identical repositories because the supply code.
- Is written in light-weight markup languages reminiscent of Markdown or AsciiDoc.
- Follows the identical branching, pull request, and code evaluate workflows.
- Is built-in into the CI/CD pipeline, the place documentation could be mechanically linted, examined, and deployed.
The important thing rules 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 could 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 manner simpler. Builders, product managers, and technical writers may even contribute in line with established workflows.
The One Supply of Fact Philosophy
One Supply of Fact implies having info in a one single location, which all people on the crew can discuss with.
It’s easy in Agile growth to have the documentation get unruly — there could be a few of it on wikis, some on shared drives, and a few buried in outdated e-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 could 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 sooner, 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 could 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 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 checks to the CI/CD pipeline. They will mechanically discover damaged hyperlinks, misspellings, or out of date references within the docs, the identical manner they will discover code.
Lastly, quite a few affluent corporations are already working towards this method. GitLab and Kubernetes initiatives have indicated that placing documentation into the event course of ends in extra secure, useful, and easier-to-use documentation.
Find out how to Implement Documentation as Code
Getting Documentation as Code reside isn’t that tough, however it’s going to take you to change the best way your crew operates. One of the best recommendation right here is to start out small and progressively transfer towards making Docs as Code part of your course of.
1. Begin Small
Initially, select a small venture or a particular module to doc utilizing Docs as Code. This step permits your crew to get conversant in 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 a way documentation could be handled like code.
2. Use the Proper Instruments
Subsequent, double-check you have got the appropriate 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, reminiscent of Markdown, AsciiDoc, or reStructuredText.
Additional, contemplate making use of static web site turbines like MkDocs, Docusaurus, or Hugo to show your Markdown information into an expert, 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 have got 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 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 evaluate them identical to you’ll evaluate code modifications.
4. Educate Your Crew
Apart from, it’s necessary to coach 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.
Interact builders, product managers, and technical writers to play lively roles in including to documentation. Collective accountability will make documentation a crew effort, not the only real accountability of 1 individual.
5. Keep away from Frequent 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 a substitute, 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 preserve your docs up-to-date, embody them within the CI/CD pipeline and encourage common evaluate. A quick reminder: when you preserve documentation a low precedence, it’s going to 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 example, add even better automation, enhance the fashion, 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 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 have to replace the documentation and likewise the code.
One other downside is duplication. Programmers wish to remark within the code how issues are completed, and sometimes this repeats the documentation.
Whereas code feedback are necessary, 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 could 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 might’t do the whole lot. 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 frequently ensures that it’s precious and correct.
Lastly, as your venture progresses, the system documentation can turn into outdated or disconnected from the place the product is. To stop this, it’s necessary to have evaluations and updates frequently.
Having an individual who has the accountability of maintaining a tally of particular areas of the documentation can even preserve the whole lot correct and true to life.
| Problem | Answer |
| Retaining Documentation As much as Date | Replace code and documentation collectively. |
| Duplication of Data | Hold code feedback technical; documentation ought to give attention to high-level data. |
| Adopting Docs as Code | Regularly transition, displaying advantages over time. |
| Automation Limitations | Common human evaluations to make sure readability and accuracy. |
| Outdated Documentation | Common evaluations 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 circumstances of firms and initiatives which have efficiently enforced this technique.
The circumstances beneath 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 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 all the crew works collectively to keep up 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 venture 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 all the 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 yet one more nice instance of how Documentation as Code is practiced.
All consumer 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.
In addition they make use of automation to test 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, making certain 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 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 offers customers with the most recent and finest info always.
The Function of Technical Writers in Docs as Code
Within the technique of Docs as Code, technical writers have a particularly necessary place. Whereas the builders write down the technical info, technical writers double-check that such info shouldn’t be tough to learn, structured adequately, and simple to know for everybody.
Technical writers remodel tough technical language into components anybody can perceive, and that is particularly important 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 all the time updated with the most recent code.
Their data makes the documentation correct, well-organized, and useful. They evaluate updates, gather strategies, and use automation instruments to catch small errors.
Normally, technical writers fill the hole between the technical facet of growth and the wants of customers, making the entire documentation course of successful.
FAQ
What’s “Documentation as Code”?
Documentation as Code is a observe of writing and conserving documentation in the identical manner builders write and preserve code — via 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 obligatory. 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 preserve documentation in the identical Git repository as code?
Retaining code and documentation separate signifies that each of them could 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.
