Which Is an Example of Documentation

Can your customers find solutions to their problems with your products or services on their own? And are they able to do so quickly and easily?

Answering yes to both of these questions is a big part of providing a great customer experience and improving your customer satisfaction rate. That’s why it’s crucial to have documentation that helps customers find answers to their questions without waiting for someone on your staff to reply. 

However, writing your online documentation from the ground up is no mean feat. It helps to take a look at brands that have done it successfully before you. So in this post, we’ll explore the different categories of documentation, and the best documentation examples in those categories. We’ll also see how you can follow the lead of the best documentation out there and create your own documentation yourself. Let’s get started. 

Examples of Awesome Documentation for Devs

Image Source — Bleeping Computer

1. Rust

Rust is a low level programming language with some buzz around its capabilities and potentiality. Rust has been increasingly garnering attention, especially in circles where there’s excitement around Web Assembly complementing JavaScript for porting software to the web.

The Rust Docs is probably my absolute favorite resource for learning more about Rust!

Why are Rust Docs Great?

  • Easily navigable
  • Beginner friendly for new programmers and/or new low level language programmers
  • The site offers both project-based learning docs and traditionally structured documentation
  • Implements embedded code blocks throughout segments of chapters that are interactive, compilable, and editable.

**Which reminds me: be on the lookout for my next article where I list awesome podcasts to listen to if you’re interested in tuning into conversations about Software Engineering, Web Dev, Data Science, or groundbreaking Math & Science topics.**

Source — Medium

2. Docker

Let’s acknowledge the fact that Docker’s practical usage guide has Night Mode toggling functionality. We’re already getting off to an amazing start here. Beyond the mode toggling…

ALSO READ:   Best Technical Documentation Tools

Why Are Docker’s Dev Docs Great?

  • Recap & Cheat Sheet sections available at the bottom of each chapter in the docs, which is important because it helps the user reinforce concepts and keywords referencing the concepts that may have slipped the mind during experimentation with setting up their environment.
  • Links are spread out across the docs which make it easier to gain insight into the information they intend to expound upon
  • Allows for backtracking before proceeding into more complex explanations of the concepts they're highlighting, which is beginner or "refresher" friendly.
Source — Hacker Noon

3. AWS Amplify

If you need a quick refresher, AWS Amplify is a cloud service for developers who may need certain aspects of their application and code handled seamlessly. This could include the backend, authentication, database management, and deployment processes.

What Makes AWS Amplify Great?

  • In the JavaScript Amplify section, there are framework-specific links that highlight very popular JS frameworks. This is great for framework-specific details for integrating AWS configurations into the frontend.

4. Digital Ocean

Something to note about Digital Ocean, something that is made clear consistently throughout the platform’s site, is that this cloud infrastructure service is adamant about everything they have being made with developers in mind. That is crucial!

What Makes Digital Ocean Docs Great?

  • Comprehensive separation of API Tutorials, Metadata Guides, and OAuth implementations for your application.
  • Side by side API notes and programming examples with an IDE-inspired background and font in relevant languages which gives developers more insight into how certain processes could be constructed in order to perform actions.

5. Heroku

Image Source — Heroku

The Heroku Dev Center really has a gorgeous documentation setup. Heroku is known for its powerful, easy deployment services for developers. There are a few things worth noting about the site.

What Makes Heroku Docs Great?

  • Provides sequential instructions for handling different programming languages and their respective packages that are critical to running tasks, service workers, result store, and message brokering systems.
  • Docs provide resources about other relevant tools that go hand-in-hand with Heroku such as Git for your code repository and deployment processes.
  • Extremely well integrated with practically any relevant technology utilized to deploy and manage processes for applications.

I go by @nnennahacks on Twitter. Let’s chat!

Get an email whenever Nnenna publishes.


ALSO READ:   Design System Documentation Best Practices

Leave a Comment