Documentation Icon

Documentation

Documentation is a set of information that describes a product to its users.
15 Stories
All Topics

Documentation divio.com

What nobody tells you about documentation

This article starts out like a bit of false advertising: It doesn’t matter how good your software is, because if the documentation is not good enough, people will not use it. People tell us that about documentation all the time. Come on, now. Get to the good stuff! In this article I will explain how you can make your documentation better, not by working harder at it, but by doing it the right way. The right way is the easier way - easier to write, and easier to maintain. OK, I’m listening. I’m listening. Documentation needs to include and be structured around its four different functions: tutorials, how-to guides, explanation and technical reference. Each of them requires a distinct mode of writing. Pay dirt! 🙌 This is an absolute must-read on the four different kinds of docs and how to effectively execute on each.

read more

Patrick Woods developermode.com

Building TwilioQuest from the ground up

Twilio uses a custom-made, 8-bit RPG game to teach developers their APIs, both online and at events like Superclass and Twilio Signal. Created by Kevin Whinnery, TwilioQuest is a premier example of how to educate developers without putting them to sleep. “Younger generations of technologists […] have grown up collecting loot and gaining XP”

read more

Increment Icon Increment

A primer on documentation content strategy

Do you have documentation? Do you have a documentation content strategy? No?!! If you want to create guides for your software, having a solid content strategy can help you write useful content. This article will walk you through how to develop that strategy, whether you’re an engineer or a technical writer, new to writing documentation or just looking to get more strategic about it.

read more

Dennis Reimann dennisreimann.de

UIengine 1.0 – a workbench for UI-driven development

Dennis Reimann: The UIengine is a tool to build pattern libraries and documentation for design systems. It helps designer and developers to work closely together and offers features to boost their productivity. Alternatives already exist in the ecosystem (Fractal, Storybook, etc). Why reinvent the wheel? Most of the existing tools focussed on the component development, but lacked ways to also provide good documentation. Some were limited to using a specific templating language or framework, which was suboptimal for me: As a freelancer I am working on many projects and each one has its own set of constraints and requirements. I wanted to build a tool with an open source license, which I could use and extend with every project I work on.

read more

React docz.site

Docz – it has never been so easy to document your things!

Docz’ high-level principles give you an idea of what they’re all about: Zero config and easy. No unnecessary build steps with confusing setups. Blazing fast. Always use the fastest things to build our tools. Easy to customize. Create something that will be easy to use and customize. MDX Based. Have the best standard to write documents. Pluggable. Plugins are the best choice when you need to be custom and flexible. Watch the demo video on the homepage to see just how nice this tool is to use.

read more

Kelly builderbook.org

Open source web app to publish documentation or books

From Kelly Burke: You can use this web app to write and sell books on your own domain. We use it for our own book, which teaches you how to build the app from scratch: https://builderbook.org/book Pretty cool. Writing your documentation or book in Mardown is amazing for a lot of writers. The reading experience on the web could be a bit better, but the app comes with all the third-party integrations you’d want to sell your book.

read more

Vue.js vuejs.org

Vue.js gets a cookbook 👩‍🍳

Unlike the guide which walks you through building a Vue app in story form, the cookbook is all about focused examples of how to accomplish specific goals with the framework. This is an excellent addition to the compendium of documentation in support of the project, and one that’s worthy of emulation once your framework has a base set of docs that are solid.

read more

Documentation docusaurus.io

Introducing Docusaurus

Facebook announced Docusaurus to more easily maintain open source documentation websites. We created Docusaurus for the following reasons: To put the focus on writing good documentation instead of worrying about the infrastructure of a website. To provide features that many of our open source websites need like blog support, search and versioning. To make it easy to push updates, new features, and bug fixes to everyone all at once. And, finally, to provide a consistent look and feel across our all our open source projects.

read more

The Changelog The Changelog #245

Open Source at Google

Will Norris (Engineering Manager at Google’s Open Source office) joined the show to talk about their new release of the Google Open Source website as well as the release of Google’s internal documentation on how they do open source. Nearly 70 pages of documentation have been made public under creative commons license for the world to use. We talked about the backstory of Google’s Open Source office, their philosophy on OSS, their involvement in the TODO group, and much more.

read more

0:00 / 0:00