1. Home
  2. Resource Lists
  3. The Ultimate List of Documentation Resources

The Ultimate List of Documentation Resources

High quality, in-depth documentation is the best way to empower your users to support themselves.  This will give you happier users and drive down support costs.

Conversely, great documentation is also the most effective way to empower your customers to do their best work.

Below we’ve compiled a growing list of the best documentation resources we could find. Have something to add? Share it with us here.

Documentation Tips

  • Doctor : An Open Source Documentation Server - Doctor uses markdown (MD) format for documentation and github for version control. Use Doctor to aggregate multiple MD files from across repositories into a single documentation site. Doctor is licensed under Apache V2.0 license. See a live demo : https://docs.minio.io We wanted a documentation server to simply organize and render our markdown pages from github. ...
  • Writing great documentation - Over the past eight years, I've enjoyed writing documentation, supporting developers, and stoking platform potentiality for LinkedIn, Twitter, Clever, and most recently, Slack. I'm always learning from the amazing people I work with and from the talented programmers & creative partnerships that sprout from these evolving ecosystems. Even so, those of us in developer relations largely have to make it up as we go along. ...
  • A Million Words Published at Work in a Remote Company - Three years ago, I shared 10 lessons from working 4 years remotely, and today I passed another milestone while working at a remote company. After almost 7 years of working at Automattic, today I published my millionth word. ...
  • 8 Great Examples of Developer Documentation - You just received an email from an angry developer. Something is wrong in your documentation, and the developer just spent hours figuring it out. Now it's your turn to update the documentation and figure out how to avoid those issues in the future. But how?It's hard to... ...
  • 14 Examples of Documentation Mistakes - When it comes to doing something right, sometimes it helps to see common mistakes others make. So here are 14 examples of common mistakes you might be making (and yes, I even included a mistake we made in our own documentation). ...
  • 8 hints for keeping your project well documented - During every project a lot of knowledge is "stored" in team members brains. Unfortunately, human memory is not the safest place to keep valuable information and that's why you have to secure the project knowledge "on paper" (of course you will use computer for that). ...
  • How a Good Product Documentation Improved Sales by 70% in Just a Month - Launching a new product for your business involves the team work, hard work, efforts over months. No matter you are running a small business or a larger one there are lots of hopes and dedication for the same to excel. There are lots of factors that are incorporated to build a successful product. ...
  • Adaptive modern product documentation - Sphinx is a well know really powerful documentation engine used extensively within the Python community. Sphinx typically is used to generate a set of static HTML pages from a selection of source files writing in reStructuredTEXT. reStructuredTEXT for those who are unfamiliar with it is similar to Markdown however it adds the concept of nesting. ...
  • Product documentation problems your startup will eventually face - Every team that is building a product goes through several phases of team sizes and communication dynamics. Stage 1: Rollerblading ? When it's just you, building things is much easier, and faster. It's easier to communicate feature details by just sitting and discussing across the table, maybe sketching out on a whiteboard and then jumping straight into coding. ...
  • FDA Compliance: Why Paper-Based Documents Won’t Work for Long - The Food Safety and Modernization Act (FSMA) was signed into law in 2011 with the goal of improving preventative food sanitation and safety measures. This shift, from reactive to proactive, includes some of the biggest changes to food production regulation in over 70 years. ...
  • 3 Reasons Why You Need to Start Documenting NOW - No matter where you are in your illustration journey, it's important that you start documenting everything you do NOW. I recommend having a "struggle journal." This could be a notebook, evernote notebook, word doc, or whatever works for you. You have struggles. ...
  • Write the Docs: Documentation Guide - Welcome! We are excited that you are going down the path of creating more wonderful documentation in the world. This guide exists to provide both novice and expert writers a best practice handbook for building, structuring, and writing software documentation. ...
  • 5 tips to become a documentation champion - 1. Chase information like a shark When something is not clear in the workings of your product, or you can't locate a file or you simply don't know if a functionality is actually there you need to chase people down. ...
  • The Importance of Documentation - Documentation : The process of recording your thoughts and experiences in a clear and concise format for future reference. In the movie The Good, The Bad and The Ugly, there's a famous quote by the Bad guy to a gunman who tries to kill him in the bathtub : "If you wanna shoot, shoot. ...
  • 10 Ways to Improve Your Documentation - This article shares 10 ways to improve documentation.  It's written for software development in the project life cycle, it applies well to knowledge bases and support documentation. Here are the topics it covers: Document with pictures if possible Give examples Don't presume to assume Anticipate problems Test your documentation Humanize your work Explore new technologies Do the documentation yourself if possible Coordinate end-user documentation with internal/system documentation Follow department or corporate documentation guidelines Check out the article and read about each topic in the original article here. ...
  • The Top 5 Reasons to Skip Documentation (But Why Should Write it Anyway) - Write documentation. We've all heard it, but few of us do it. Why? We'll it's pretty easy to justify skipping it. In fact, it's easier to justify skipping it that writing it. Ben Mullins, the author of the article this post is based on, says it well: Somewhere in the back of our minds, everyone working on a software project is aware that documentation is a very good thing to have. Despite this awareness, documentation is often prioritized lower than it should be. Well, this post is dedicated to celebrating those top reasons to skip writing documentation (and discuss why you… ...
  • 10 Tips on Creating Superb Customer Support Documentation - Here are some tips on how to create great end user documentation with accompanying examples from companies who are doing it right shared in this article. The goal of your end user documentation is to reduce the number of hours you spend explaining workflows, and reduce the number of hours end users spend looking for answers. If you can remove hurdles your end users have to jump over in order to find answers, they will reference your documentation. And that will create self-sufficient end users who do the job correctly, in less time, and without constantly involving you. Here are… ...
  • Elements Of Writing Good Documentation - Have you ever heard the phrase, "Read The Finely-written Manual?" The manual, being the ultimate source of truth and value for that tool or framework you're learning; at least, so it should. Like many of you developers, members of TechMasters have some pain points and words of wisdom to share regarding how documentation (or "docs") should be written or read, which I have summarized here. ...
  • Documentation: Writing it is the Worst, Having it is the Best - Somewhere in the back of our minds, everyone working on a software project is aware that documentation is a very good thing to have. Despite this awareness, documentation is often prioritized lower than it should be. Many understandable motivations contribute to documentation's low prioritization. ...
  • Everything You Need to Know About Documentation - It's 11p.m., you're driving down a remote road on a clear, starry night when Pop! the stillness of the dark is shattered by a blown-out tire. You're safe but stranded in the middle of nowhere. Denial and panic are soon followed by acceptance as you realize there must be a spare tire and jack somewhere in the car. ...
  • 10 Things You Can Do to Create Better Documentation - Providing IT professionals with a unique blend of original content, peer-to-peer advice from the largest community of IT leaders on the Web. ...
  • 5 Keys to Writing Awesome Documentation - We all know the value of excellent documentation, but most of us still struggle to write it well. Poorly written documentation is like food that tastes bad or that's hard to eat. The sole purpose of documentation is to be read, so it must be well organized and optimized to be easily read and understood. Whether you're writing documentation for your product's knowledge base to help customers or for your company's internal knowledge management program to help employees this post is for you. Here are the 5 keys to write awesome documentation excerpted from Elements Of Writing Good Documentation, which… ...

Technical Documentation Tips

  • The Importance of API Documentation - Have you faced API projects, where the links are not working? Files can not be downloaded? There are loads of data, but you don't know how to access it or use it? Or you will just be redirected to Github page with short project description? ...
  • API Documentation With Swagger - Documentation is a set of documents provided on paper, or online, or on digital or analog media, for example, quick-reference guides. As a developer, it is very important to have reliable documentation about your work. It helps to jump into any development, maintenance and knowledge transfer of application. ...
  • If documentation was written but never read, did it ever exist at all? - Also in response to the article on "Documentation is a bit like people dying", I also find that none of my clients believe in an afterlife, or at least none of them reach out to me after I pass on... ...
  • Semantic Documentation - I've been playing around a lot with API design lately because I have an API project coming up at Argu. But one of the things missing a lot from the design standpoints was one of the (in my opinion) most important aspects, the documentation. ...
  • Perfect Documentation - Perfect documentation should be: Yes, you see correctly only one point.It should be auto-generate as much as it is possible to be good. Who works on the project - I don't want to provide this information by hand. ...
  • Technical writing in the world of SaaS - Documentation is an oft-neglected area of software development and it has a reputation for being inscrutable to the common man. Definitions like this inform many people's inaccurate view of software documentation. Does anyone really read the manual, and do manuals even exist for most SaaS software? ...
  • Agile Documentation: Best Practices - As you know, Agile Manifesto claims "working software over comprehensive documentation". So you might get the impression that Agile methodology rejects all documentation. Then you are wrong. We will provide a brief overview of the best practices of Agile documentation. Yes, indeed static documentation is too rigid for Agile. ...
  • Create beautiful documentation in minutes with Laravel Codex - Codex is a file-based documentation platform built on top of Laravel. It's completely customizable and dead simple to use to create beautiful documentation. Codex is able to do things like transforming markdown or automaticaly fetching documentation from a Bitbucket/Github repositories. Most of it's features are provided by addons. ...
  • Documentation Driven Development (DDD) — I thought, I discovered “Something New!” - " Any fool can write code that a computer can understand. Good programmers write code that humans can understand. " - Martin Fowler Yes, your must never write code for yourself and that is what I was doing while working on infrastructure and APIs development. ...
  • Why Code and Documentation are Broken - What makes how people think different from how computers think is our use of concepts. Reading the news doesn't simply tell me that tell me that a drinking wine might not be as good to our health as we previously thought ( Red Wine is bad for you Say Experts). ...
  • Junior Developers Bring Knowledge, Documentation, and a Fresh Pair of Eyes - Six months ago, I joined NNIT and embarked on my journey as a Graduate. So far the journey has been incredible and I'm just about to start my second module in a new department. Being a graduate is rather different from joining a company in a specific position. ...
  • Why you should document your self-documenting code - First and foremost we should agree on the definition. I understand self-documenting code as a code that can not be possible made any more transparent by adding new textual artifacts to it that are not code. Is this ok? Now I want you to see this. Three lines. ...
  • Importance of proper documentation in a project - In the tech industry, it's not uncommon for developers to work on project maintenance. You could be asked to fix a few bugs in a system which is already in production and has a user base. Or to add new features, or to refactor. ...

Was this article helpful?