Software documentation is a crucial part of working software.
Whether it’s API documentation, release notes, or customer-facing help content, you can’t afford to skip over the docs when it comes to shipping your new product.
“Documentation is one of the most important parts of a software project. However, a lot of projects have little or no documentation to help their (potential) users use the software,” says Eric Holscher, co-founder of Write the Docs.
51% of people prefer to receive technical support through a knowledge base, and yet producing the relevant technical documentation can be a headache for many companies.
Luckily, there are many examples of software brands leading the way with documentation, and we’re going to take a look at some documentation best practices in this post.
Looking at other software documentation examples can inspire your own project, although your processes will be entirely your own.
Types of Software Documentation
First and foremost, there are several types of software documentation, but the two main categories are product documentation and system documentation.
Each documentation type requires a slightly different approach since they are aimed at different audiences.
Daniel Procida from Divio talks about the four different types of software user documentation (and remember, users can also be developers):
- How-to guides – Problem-oriented, take the user through a series of steps to reach a real-world goal
- Tutorials– Learning-oriented, take the user through a series of steps to learn a concept
- Reference docs – Information-oriented, technical descriptions of the software (could include software design documents)
- Explanations– Understanding-oriented, they clarify or illuminate a particular topic for a user
For Developers Only
Your users can also be developers, and there are very specific types of documentation aimed at developers only. This is where it gets fascinating, but some developer-only docs include:
- API documentation – Reference documentation regarding making API calls and classes
- Release notes – Information describing the latest software or feature releases, and bug fixes
- README– A high-level overview of the software, usually alongside the source code
- System documentation – Documents describing the software system, including technical design documents, software requirements, and UML diagrams
Consider code documentation that lives alongside the software, possibly in GitHub or similar tool – otherwise, none of your developers will read it.
Distinguish between internal software documentation and external end-user facing documentation – you typically need different writers with each.
We’re going to focus mostly on end-user facing documentation in this guide.
Follow the Pre-Writing Exercise
You can also consider writing documentation as part of the “pre-writing” exercise for writing code – this is especially useful when you have multiple developers working on the same feature.
As James Hood, Senior Software Developer at Amazon, says: “As the size and complexity of a feature grows, so does the amount of pre-writing required, especially when multiple developers are going to be collaborating on a feature.”
You’re not writing code per se, but you’re writing about the code you are going to use in order to solve a particular problem.
It’s like brainstorming the solutions you are going to use in your software before you actually implement any code.
Identify Your Target Audience
If your target audience is not internal, then your audience is likely to be your customer base.
However, it may still be possible to segment your customer base down even further.
Splunk provides an in-depth guide in their book The Product is the Docs on how to define your audience for technical writers.
Here’s a quote from Splunk: “Reliable and accessible documentation requires thorough product knowledge. It also applies equally, if not more, on knowing your audience.” – Splunk, p.275
This is an exercise that is useful not just for technical writers but also for other members of your company, including marketing, engineering, product, and support.
- Define your user. You can start with available user information and talk to customer-facing teams like support.
- Identify your user’s goals (e.g., install a database).
- Create audience personas.
- Create audience definitions (e.g., entry-level admin audience).
- Create use cases for the product (e.g., manage enterprise customers in a CRM system).
- Identify the correct delivery formats for your users (e.g., FAQ, wiki, or knowledge base).
- Create content that is an appropriate scope and at the right level of detail.
- Identify appropriate users to provide feedback on your documentation.
- Conduct user research and communicate with users.
Remember, your software users may change over time. Repeat this exercise at least once a year.
Follow Agile Documentation Practices
It’s increasingly common for software technical writers to work in Agile rather than Waterfall – The Agile approach to software documentation is used by 71% of companies for their software projects.
The definition of the Agile Manifesto is:
- Individuals and interactions over processes and tools
- Working software over comprehensive documentation
- Customer collaboration over contract negotiation
- Responding to change over following a plan
The Docs Like Code methodology is a subset of Agile, and it means using the same tools and processes for the docs as you would for the software.
You’re aiming for the minimum possible amount of documentation. You can learn more about it in Anne Gentle’s book, “Docs Like Code”. Anne says:
“GitHub and similar code systems avoid documentation ghettos because writers use the same tools that developers use. By adopting software techniques such as continuous integration, automated testing, and incremental improvement for docs, you get docs that are on par with the code itself.” – Anne Gentle, p. 16
Make your tech writers part of every scrum team instead of having a dedicated documentation team, since this encourages better collaboration between writers and developers.
When producing documentation, you will need to think about version control, source control, and collaboration.
Keep your documentation tasks in the same tools as the software, such as Jira.
Instead of having your own Content Management System, use the same version control software that your developers use for the code.
Just In Time documentation is a subset of Agile methodologies and originates from the Toyota Production System.
Instead of documenting every feature comprehensively, you produce articles as they become necessary based on your customer support tickets.
Naturally, this approach relates mostly to customer-facing product documentation rather than system docs or API docs aimed at technical folks. With develop-facing documentation, you want to try to be comprehensive.
Minimum Viable Documentation is an approach that makes sense when you have limited access to technical writing resources, and you have to produce relatively large amounts of documentation at speed.
It means that you aim for the minimum amount of content that you need to be successful, and no more.
Agile for All says: “We certainly don’t need “just in case” documentation, but I also believe it is a fallacy to think agile teams can be effective with zero documentation.
We need just enough documentation to make sure the team is successful.”
Prioritize Documentation in the Development Process
Software documentation can easily fall under the radar until the last minute unless you make a concerted effort to prioritize through the Software Development Lifecycle.
Don’t allow developers to ship a feature unless it is accompanied by the appropriate documentation.
Hire technical writers who can promote the value of documentation within your company – Splunk has some great advice on how to do this.
Using the same tools as your development team can really help with this, since your documentation is far more visible.
For example, Splunk says: “So what makes a technical writer exceptional? Resourcefulness and eagerness are key. When you screen tech writer candidates, look for a real appetite for discovery. The job, fundamentally, isn’t about writing or learning technology. It’s a relationship business, more like investigative journalism than anything else.” – Splunk, p.634.
We’ll cover the importance of hiring technical writers in a later section.
Docs Or It Didn’t Happen is part of the ethos of Write the Docs' community – essentially meaning that no software or feature is complete without the relevant documentation.
This means empowering everyone on your development team to be a documentarian, from engineering, to product, to support, although not everyone will not directly write the documentation.
Develop a Content Strategy
Documentation won’t appear by itself. Especially when you have a complex product that changes frequently, you need to take a conscious approach to how you produce documentation.
Your content strategy draws on your audience's definitions in determining the approach you take.
Even if you use Just In Time methodologies, you have to think about your documentation as a whole.
For example, do a comprehensive audit of your docs – many companies have the same content living in more than one place, reams of outdated documentation, or content that is just plain wrong.
A documentation content strategy helps you keep on track, allocate resources, and manage your time. It will help you time your documentation alongside releases so you can have some idea of what’s coming up.
It can be particularly helpful for engineering teams, as this article by Increment explores.
According to Increment, “Content that maps to the audience’s needs lead to better comprehension and less confusion and frustration; it presents helpful information that explains confusing tasks and concepts, and anticipates where their challenges might occur.”
Work Closely With Subject-Matter Experts
In software documentation, no one person has all the answers and your technical writers will be evaluated on their ability to get the most about Subject-Matter Experts.
As Splunk says: “Your relationship with your subject-matter experts is essential to your success. Many of these SMEs will be engineers.” – Splunk, p. 2218
- Understanding the engineering workflow
- Learning the language of engineers so you can use it to speak to them
- Doing your homework on the software before meeting any engineer
- Familiarizing yourself with the terminology of the product
Your developers are likely to know the product so well that it may be hard to get practical answers from them that can translate into documentation.
Documentation should not only be written by technical writers – it should ideally be a synchronized collaboration between your documentation team, engineers, and support.
You need to make time for the technical review so that your SMEs can verify the accuracy of your documentation, as well as testing your docs on users.
QA and Testing
We already touched on Quality Assurance (QA) for your documentation a little when we talked about using Agile methodologies.
Documentation should not be published until it has been subject to technical verification, which is the point when QA tests your documentation to see if whatever solution you have presented works.
Your customers should not be the first testers of your documentation, or you have failed to provide working docs.
Build this testing phase into your Agile process so that team members leave time to test before the product or feature ships.
You also need to include a phase where the relevant members of the product or engineering team review your documentation to check for technical accuracy, so this is where strong relationships between teams come in very handy.
Make sure you formalize your process to ensure all team members appreciate the importance of the documentation.
Do not allow the code to merge until documentation has been approved.
Customer Feedback Loop
Closing the customer feedback loop is all part of the Agile process. Agile development should be continuous communication between the development team and the customer, at all stages of the process.
From beta testing with a research group, to feedback on the first release, and ongoing feedback from customers, you need to keep your finger on the pulse. It doesn’t always have to be a formal research group.
There are many ways to collect feedback:
- Knowledge base contact form
- Enabling comments on documentation
- Allow users to “rate” the usefulness of the content
- Check your knowledge base data analytics
- Customer support tickets
- Social media
Closing the feedback loop means connecting the feedback with the right internal department.
If customer support gets an issue with the software, this needs to be passed on to the engineering team and logged as a bug or a feature request.
If there’s a problem with how the product has been marketed, this needs to be passed on to the marketing team.
You get the idea!
Create a Style Guide
You absolutely need a style guide for your software documentation, just like you would for your marketing activities. The main things you should cover in your style guide are:
- Standardized terminology (how to refer to your company and software)
- Voice & tone
- Page formatting (use of headers, paragraphs, lists)
- Guide on word choice (should it be internet or Internet – obviously the former!)
- Use of visuals and video
For advice on grammatical choices, such as whether to use the Oxford Comma, you can check standard style guides such as the Chicago Manual of Style.
Adopt a coherent writing style, especially if you are using teams of writers who all write in different styles. This all adds to the User Experience of the documentation, which we will discuss later.
Software documentation templates can come in really handy so your writers don’t have to consult the style guide every time.
And you can either make them yourself, search online, or find them in enterprise content tools like Atlassian Confluence.
Think About User Experience
You will need to consider the User Experience (UX) of your documentation, especially customer-facing help content.
Just writing the content is half the battle – how do customers feel when they encounter your knowledge base? Are they able to easily find what they need?
If you invest in knowledge base software like Helpjuice, you will have built-in templates with UX designed just for documentation users.
The Information Architecture of your knowledge base (IA) follows the same principles as for any other IA projects, and is an aspect of User Experience.
This is where professional technical writing help is very important, which we’ll cover in a later section.
Information Architecture refers to:
- The structural design of shared information environments.
- The combination of organization, labeling, search, and navigation systems within websites and intranets.
- The art and science of shaping information products and experiences to support usability and inability.
- An emerging discipline and community of practice focused on bringing principles of design and architecture to the digital landscape
Check out this API documentation portal from Slack:
Inclusivity and Accessibility
When you get to a certain point in your documentation, you need to seriously consider how people with different needs will be able to use your documentation.
For example, consider whether your users are from international audiences when actually writing content. You want to avoid the use of idioms and references that they might not understand.
Accessibility relates to the User Experience of the documentation tool itself. For example, consider whether it will be accessible to a person using a screen reader, which will read the test aloud to a person using it.
Images with text overlaid are not accessible, so think about your screenshots and make sure they have accompanying text.
Take into consideration the contrasting colors of your knowledge base design, and how you style links, to ensure other users with visual impairments can engage with your site successfully. Take this example from Write the Docs' website:
The site design is very clear, easy to use, with underlined links and short paragraphs. The black and white color scheme provides a high contrast for visually impaired users.
Consider how customers arrive at your knowledge base in the first place. Very few customers will consider your knowledge base as a whole, and hardly anyone will arrive at your carefully constructed homepage.
Consider Every Page is Page One principles as described by Mark Baker. According to EPPO, people “forage” for information like animals searching for food, rather than learning in a linear fashion as you would with a book.
There is no “beginning: to start from.
Mark says: “There is no “Start Here” page for the Web. Wherever you dip your toe into the Web, that is your page one. We can’t avoid this. Whether you are a reader or a writer, and whether you like it or not, that is the way the Web works. Every page is page one.” – Mark Baker, p.141
Your software documentation is no good if nobody can find it, but there are a number of ways to promote your content. In fact, Google’s search engine is often “page one” for many users.
The best knowledge base software should be indexable by search engines, with all the correct meta tags. You should also link to your documentation from your software app, since this is where users will naturally get stuck.
If possible, make use of contextual help which is served up whenever customers need it.
For example, if customers are having trouble with their billing, ensure a link takes them to a page with billing documentation that can help solve their problem.
Here’s an example of contextual help inside Slack:
Choose the Appropriate Software
To deliver the documentation to your users, you need the appropriate software documentation tool. You might be fine using GitHub and a Static Site Generator, or you might need a tool with better User Experience.
Using knowledge base software like Helpjuice enables you to easily create and publish documentation in a stylish website optimized for search and discovery.
Check out this example of a Helpjuice knowledge base by WealthBar:
As you iterate on versions of your product or features, you’ll need to keep track of the different versions of your documentation.
This can even mean creating entirely new knowledge bases and maintaining several KBs for different versions of the product.
Helpjuice allows you to create different versions of your documentation and even switch between them in the editor.
Many companies need to keep different versions of their documentation live at the same time for customers who are using different releases.
Keeping track of your documentation tasks in collaboration tools like Asana or Trello is also essential. Whatever your tool, make sure everyone is using it for maximum productivity.
Lightweight Markup Languages
Consider whether you want to work in a lightweight markup language. This can be especially useful if you’re working with Docs like Code and you want to keep your content alongside the codebase.
Tools like GitHub allow you to work in Markdown and generally it’s necessary for your technical writers to be able to use markup.
There are a few different options when it comes to markup languages:
One of the advantages of working in a lightweight markup language is that content can be easily styled and presented in a visually appealing way.
Also, if you need to migrate your content over to a different system, if it’s written in markup then you can keep all the formatting in your content.
Here’s a preview of Markdown in text editor Atom:
Hire Professional Technical Writers
There’s nothing wrong with your developers writing documentation if necessary, but at some point, it’s not the best use of their time.
This is where professional technical writers come in. You can outsource your technical writing to an agency or you can hire in-house expertise.
One thing you can’t ignore is the importance of professional technical writing skills.
If you want to achieve anything like success with your User Experience, Information Architecture, and understanding of your audience, then professional tech writing experience is essential.
Your documentation gives an important impression to your customers that you care about their success with your software and you have provided help for when they run into problems.
Unprofessional documentation can also be off-putting to potential customers.
Documentation is never done, and you’ll always have to iterate on your efforts. Set time aside to review the documentation, identify missing documentation, or improve documentation that is frequently used.
This relates to the customer feedback loop. Quickly act on comments from your customers that tell you your documentation is failing to solve a problem.
Make the time to talk to your support agents about what documentation they might find useful, and even empower them to create it themselves!
This has been a lot to take in! Feel free to refer back to this guide as you develop your software documentation strategy and start reaching new heights of user success.
Good documentation practices are just as important a part of the software as the code. Build the documentation into your development process and try to use the same Agile methodologies.
This article is a broad overview and there is still so much more to learn. We’ve only touched on many important topics when it comes to your documentation, so keep researching to develop your knowledge in greater depth.
As Splunk says: “If the product is docs and docs are the product, then you are a designer, a developer, and a product manager, too.” – Splunk, p.2246
Examples of software project documentation include: Project plans. Product roadmaps. Test and release schedules.How do you write a good documentation for software? ›
- Understand the Purpose and Audience of the Document. ...
- Jot Down Important Questions. ...
- Outline Technical Documentation. ...
- Gather the Required Information. ...
- Write Documentation Drafts. ...
- Leverage Good Documentation Visuals. ...
- Perform Final Editing.
- learning-oriented tutorials.
- goal-oriented how-to guides.
- understanding-oriented discussions.
- information-oriented reference material.
An everyday example of this type of best practice is to look both ways before crossing the street. It isn't a law to look, and people may find some success if they don't do it. But this often-repeated piece of advice produces the best results in the long run if followed.What are the examples of documentation? ›
Examples are user guides, white papers, online help, and quick-reference guides. Paper or hard-copy documentation has become less common. Documentation is often distributed via websites, software products, and other online applications.What are the types of software documentation? ›
- Process documentation. ...
- Planning documentation. ...
- Estimate documentation. ...
- Standards documentation. ...
- Metrics documentation. ...
- Scheduling documentation. ...
- Product documentation. ...
- System documentation.
In the software development process, software documentation is the information that describes the product to the people who develop, deploy and use it. It includes the technical manuals and online material, such as online versions of manuals and help capabilities.What is documentation of project with example? ›
Project documentation is the process of recording the key project details and producing the documents that are required to implement it successfully. Simply put, it's an umbrella term which includes all the documents created over the course of the project.What are the two types of documentation? ›
Documentation can relate to two different types: products and processes. Product documentation describes the product under development and provides guidelines on how to execute actions with it. Process documentation, on the other hand, relates to all the material created during development.What is the format of documentation? ›
A documentation style is a standard approach to the citation of sources that the author of a paper has consulted, abstracted, or quoted from. It prescribes methods for citing references within the text, providing a list of works cited at the end of the paper, and even formatting headings and margins.
Effective documentation collects all of the must-know information about a task, project, or team (from account logins to step-by-step instructions) in a centralized, organized place. No more digging through email or downloaded files for the latest information.What are 3 types of documents? ›
- HTML files.
- Microsoft PowerPoint presentations.
- Microsoft Word documents.
- Plain text documents.
Although there are many explicit purposes for creating a scientific or technical document, there are four general categories: to provide information, to give instructions, to persuade the reader, and to enact (or prohibit) something.What is the difference between good practice and best practice? ›
Whenever it is recommended that a practice should be followed, it is said to be a best practice. When this practice becomes a part of life, it becomes a good practice.What are examples of best practices in business? ›
- Engage Your Employees. Studies have found that 68% of employees are disengaged in their work. ...
- Adopt Flexible Work Policies. ...
- Lead by Example. ...
- Develop an Open Management Style. ...
- Reward Achievement. ...
- Focus on Alignment. ...
- Communicate a Clear Mission and Strategy. ...
- Hold Regular Check-In Meetings.
- become more competitive.
- increase sales and develop new markets.
- reduce costs and become more efficient.
- improve the skills of your workforce.
- use technology more effectively.
- reduce waste and improve quality.
- respond more quickly to innovations in your sector.
1 : the act or an instance of furnishing or authenticating with documents. 2a : the provision of documents in substantiation also : documentary evidence. b(1) : the use of historical documents. (2) : conformity to historical or objective facts.What is the difference between document and documentation? ›
"Document" means a specific collection of words you can point to, either sitting on a table or in a computer. Eg, a book or manual. "Documentation" means a somewhat looser collection of words, possibly scattered across a desk or across the interweb.What is proper documentation? ›
Proper Documentation: includes – doctor's note with date, hospital bill or record for you or and immediate family member; jury duty form; funeral home document for a death in the family; tow slip with date and time.What is documentation process and types? ›
Process documentation is a step-by-step description of how to execute a process from start to finish. Processes can be documented in the form of policies, checklists, tutorials, forms, screenshots, and so on – anything that describes how a process should be executed.
Why are Best Practices Important? Best practices are important for processes that you need to work correctly. They are simply the best way to do things and have been worked out through trial and error, and are found to be the most sensible way to proceed.What is Alcoa in good documentation practices? ›
It stands for Attributable, Legible, Contemporaneous, Original, and Accurate. By embracing these principles across a company's data management system, businesses can ensure that the data they're collecting is accurate and that outlined processes are being correctly followed.What are the 3 rules of documentation? ›
- Immediate. Managers should take notes right after an incident occurs. ...
- Accurate and believable. When an outside observer (judge, jury or EEO investigator) is called to judge your side of the story, detailed observations add authenticity. ...
- Agreed upon.
Although there are many explicit purposes for creating a scientific or technical document, there are four general categories: to provide information, to give instructions, to persuade the reader, and to enact (or prohibit) something.What are the characteristics of good documentation? ›
- All relevant information must be recorded.
- All paper records must be legible, signed and dated.
- Records must be contemporaneous, accurate and kept up to date.
- Records must be written in plain English avoiding jargon.
- HTML files.
- Microsoft PowerPoint presentations.
- Microsoft Word documents.
- Plain text documents.
- DAR (data, action, response)
- APIE (assessment, plan, intervention, evaluation)
- SOAP (subjective, objective, assessment, plan) and its derivatives including.
- SOAPIE (subjective, objective, assessment, plan, intervention, evaluation).
Whenever it is recommended that a practice should be followed, it is said to be a best practice. When this practice becomes a part of life, it becomes a good practice.What are the limitations of best practices? ›
- Best practices can dilute an organization's strategic differentiation. ...
- Best practices may enforce a limiting industry paradigm. ...
- Best practices can expose underlying worldviews. ...
- Best practices can preserve functional area power.
According to the ALCOA principle, the data should have the following five qualities to maintain data integrity: Attributable, Legible, Contemporaneous, Original and Accurate.What are the 9 principles for ensuring data integrity in documentation? ›
- Principle #1: Attributable. The first principle of ALCOA+ can be summarised quite simply: ...
- Principle #2: Legible. ...
- Principle #3: Contemporaneous. ...
- Principle #4: Original. ...
- Principle #5: Accurate. ...
- Principle #6: Complete. ...
- Principle #7: Consistent. ...
- Principle #8: Enduring.