12 π Technical Documentation
Skill Level: β Beginner β β β Intermediate β β β β Advanced
12.1 Best Practices
12.1.0.1 How to name files by Jennifer Bryan of Posit - Video β
Low-tech common sense about filenames. The holy trinity is: machine readable, human readable, sorted in a useful way
12.1.0.2 The Documentation System - Reference β β
A simple, comprehensive and nearly universally-applicable scheme for writing software documentation
12.1.0.3 DiΓ‘taxis technical documentation system - Reference β β
This reference describes an information architecture that emerges from a systematic approach to understanding the needs of documentation users
12.1.0.4 How To Write a Useful README for Your Next Project - Article β
An article outlining the βmust-havesβ for any projectβs README file
12.2 Markdown & Quarto
12.2.0.1 Getting Started: An overview of Markdownβ¦ - Reference β
The Markdown Guide is a comprehensive Markdown reference designed for both novices and experts
12.2.0.2 John Gruberβs Markdown documentation - Documentation β β
The original Markdown documentation, written by the creator of Markdown
12.2.0.3 Markdown Tutorial - Tutorial β
A web-based walk-through of Markdown basics
12.2.0.4 Awesome Markdown - Reference β β
A listing of Markdown libraries, services, editors, tools, cheatsheets, etc.
12.2.0.5 Awesome Quarto - Reference β β
The most up to date curated list of Quarto docs, talks, tools, examples & articles the internet has to offer
12.2.0.6 R Markdown Tips, Tricks, and Shortcuts - Blog β β
A blog post with some helpful tips and tricks for working with R Markdown in RStudio
12.2.0.7 Trello Markdown Support - Reference β
A reference chart that indicates which Markdown features are supported in Trello, along with a link to their syntax
12.2.0.8 How to format your text in Trello - Tutorial β
A quick guide to the keyboard shortcuts and Markdown features available in Trello
12.2.0.9 Quarto Example Gallery - Tutorial β
Quarto can produce a wide variety of output formats. This resource contains examples of the following categories: Articles & Reports, Presentations, Dashboards, Websites, Books, Interactive Docs
12.3 Table Formatting
12.3.0.1 The Design Philosophy of Great Tables - Article β
Tables have come a long way and weβve learned a lot from our continued research in tabular design. This article walks through the philosophy behind the Great Tables package