Note: This section of the site is under heavy construction, tread carefully.

Bookmarks tagged with “documentation”

106 bookmarks by garrettc


Markdoc | A powerful, flexible, Markdown-based authoring framework

"Markdoc is a Markdown-based syntax and toolchain for creating custom documentation sites from Stripe."

Bookmarked on #


readme.txt

"Titbits and curios from the video game mod archives. Curated by Alice O'Connor."

Bookmarked on #




Django Class-Based-View Inspector

Detailed descriptions, with full methods and attributes, for each of Django's class-based generic views.

Bookmarked on #


Easiest Way to Create A README

Use readme.so's markdown editor and ready made templates to easily create a simple README for your repositories

Bookmarked on #


Diátaxis document framework

The Diátaxis framework aims to solve the problem of structure in technical documentation. It adopts a systematic approach to understanding the needs of documentation users in their cycle of interaction with a product.

Bookmarked on #


The documentation system

"There is a secret that needs to be understood in order to write good software documentation: there isn’t one thing called documentation, there are four. They are: tutorials, how-to guides, technical reference and explanation. They represent four different purposes or functions, and require four different approaches to their creation. Understanding the implications of this will help improve most documentation - often immensely."

Bookmarked on #


Django Class-Based-View Inspector -- Classy CBV

"The best way to understand Django's class-based views is to see it in Classy CBV, so pick your version and jump in at the deep end."

Bookmarked on #


Stoplight

"Using Stoplight you can create OpenAPI descriptions, documentation, mock servers much faster than other API tools, with no specialized knowledge required in one centralized platform."

Bookmarked on #


MarkDown

Convert from JIRA text formatting to GitHub Flavored MarkDown and back again

Bookmarked on #




A highly opinionated guide to learning about ActivityPub

"This document is for programmers who take one look at activitypub.rocks, click on through to the documentation, and can't make heads or tails of it."

Bookmarked on #


Etsy’s experiment with immutable documentation

A super interesting look into how Etsy prevents documentation from going stale by splitting it into “how” docs (prone to change), and “why” docs (less likely to change)

Bookmarked on #


Get Started, Part 1: Orientation and setup

Get oriented on some basics of Docker before diving into the walkthrough.

Bookmarked on #


A Human-Readable Interactive Representation of a Code Library

"A how-it-works-style research prototype for understanding a code library."

Bookmarked on #


Introducing Kit

Say hello to Kit, a set of tools for developing, documenting, and testing React components.

Bookmarked on #



W3C Process for Busy People

"This document aims to provide readers with a shorter overview of the W3C Process Document written in plain English. The original W3C Process Document is a complete document, written to be legally accurate and give indepth detail on each item and process. This document aims to give an overview of the main document, so new and existing W3C participants can gain an understanding of all W3C processes and know where to go for more information."

Bookmarked on #


12 “Manager READMEs” from Silicon Valley’s Top Tech Companies

"When we launched our first SoapBox hero I was surprised to discover a document used to introduce her working style to her team. I had never seen that before and it was awesome! Did others have these? I needed to know. Eventually, I found a treasure trove of examples by Engineering Leaders from companies with some of the best culture in tech. They called them Manager READMEs, or Manager User Manuals. And they’ve graciously let me share them with you."

Bookmarked on #



“Just”

I feel like an idiot while doing my job.

Bookmarked on #


Just Barely Good Enough Models and Documents: An Agile Best Practice

"For some reason people think that JBGE implies that the artifact isn't very good, when in fact nothing could be further from the truth. When you stop and think about it, if an artifact is JBGE then by definition it is at the most effective point that it could possibly be at."

Bookmarked on #


Swagger

Aides in development across the entire API lifecycle, from design and documentation, to test and deployment.

Bookmarked on #


Ten Extras for Great API Documentation

If you manage to create amazing API documentation and ensure that developers have a positive experience implementing your API, they will sing the praises of your product. Continuously improving your API documentation is an investment, but it can have a huge impact.

Bookmarked on #


Infusion: An Inclusive Documentation Builder

"Infusion is a high performance generator of rich and accessible documentation sites in the form of progressive web applications (PWAs). That means the documentation sites you create can be saved to your devices and read offline. Because Infusion instances exist as Github repositories, this is possible out of the box. When you commit and push changes to your content, your Github Pages site is updated and a new service worker is installed."

Bookmarked on #


What nobody tells you about documentation - Blog - Divio

"There is a secret that needs to be understood in order to write good software documentation: there isn’t one thing called documentation, there are four. They are: tutorials, how-to guides, discussions and technical reference. They represent four different purposes or functions, and require four different approaches to their creation. Understanding the implications of this will help improve most software documentation - often immensely."

Bookmarked on #


5 Keys to Writing Awesome Documentation

"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."

Bookmarked on #


BBC micro:bit MicroPython documentation

A really really good example of well written docs, super friendly and easy to follow.

Bookmarked on #


Guru

Guru is a knowledge sharing solution built to enable sales and support teams with the knowledge they need when they need it, without leaving their workflow

Bookmarked on #


Design systems, style guides, pattern libraries. What the hell is the difference?

"And this got more complicated when we came with style guides. Or maybe component libraries. Or pattern libraries. Did you hear about design systems? It’s the big thing for 2017. Are they the same? Is there a difference? Why don’t we call it simply documentation?"

Bookmarked on #



API Design Guide

"This is a general design guide for networked APIs. It has been used inside Google since 2014 and is the guide we follow when designing Cloud APIs and other Google APIs. It is shared here to inform outside developers and to make it easier for us all to work together."

Bookmarked on #


I Don’t Need Help

Just because your users don’t ask for help doesn’t mean they don’t need it.

Bookmarked on #


Design system documentation

"Here is a list of links to all the online design system documentation of note I found while researching how other teams document their design systems, brand guidelines and styleguides."

Bookmarked on #


How (and why) to write good documentation

Patience and empathy are the basis of good documentation, much as they are the basis for being a decent person. Here's a how-to for creating better open source project docs, which can help your users and grow your community.

Bookmarked on #


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). In this article I’ll try to give some hints that I’ve found reasonable for the 3 most common types of documents."

Bookmarked on #


PagerDuty Incident Response Documentation

A collection of information about the PagerDuty incident response process. Not only how to prepare new employees for on-call responsibilities, but also how to handle major incidents, both in preparation and after-work.

Bookmarked on #



18F Slack Handbook

A great internal document from the US Government digital team about how to use Slack.

Bookmarked on #


Design System Doc Components

Excellent tips and advice for documenting a design system.

Bookmarked on #



Five tips for improving your technical writing and documentation.

Get more users and fewer support requests by leveling up your writing and technical documentation.

Bookmarked on #





TLDR pages

Simplified and community-driven man pages

Bookmarked on #


MkDocs

Static site generator to build project documentation with Markdown.

Bookmarked on #


How to Produce a High Quality Screencast

Tutorial on how to produce a high quality screencasts

Bookmarked on #