Steve Losh • 9/3/2013

Teach, Don't Tell

Read Original

This article explores the philosophy and practice of writing great technical documentation for programming languages and libraries. It argues that documentation's core purpose is to teach users from novice to expert, and outlines a structured approach with principles and actionable advice, referencing other key works on the subject.

0 comments
#software development #programming #api
Teach, Don't Tell

Comments

No comments yet

Be the first to share your thoughts!

Browser Extension

Get instant access to AllDevBlogs from your browser

Top of the Week

1
The Beautiful Web
Jens Oliver Meiert • 2 votes
2
When your coding agent doesn’t understand your project, you’ll get junk
Benjamin Cane • 1 votes
3
LLM Use in the Python Source Code
Miguel Grinberg • 1 votes
4
Wagon’s algorithm in Python
John D. Cook • 1 votes
5
An example conversation with Claude Code
Dumm Zeuch • 1 votes