Authoring Documentation for Paclets

Brian Van Vertloo, Wolfram Research

(RowDefault[, (Spacer1), , (Spacer1), ])  #WolframTechConf

Paclet Documentation

So you’ve got some neat code... now what?

Paclet Documentation

So you’ve got some neat code... now what?

Tell everyone how to use it!

A Brief History of Paclet Documentation

A Brief History of Paclet Documentation

Wolfram Workbench: DocumentationTools

A Brief History of Paclet Documentation

DocumentationTools built right in!

Types of Documentation Pages

Types of Documentation Pages

Reference (Symbol, Function) Pages

Defines a function’s usage, including options and examples

Heavily structured and uniform

Types of Documentation Pages

Guide Pages

Collections of symbols in coherent groups of functionality

Types of Documentation Pages

Tech Notes

Narrative descriptions of functions, including more in-depth examples

Loosely structured, more free-flowing

Let’s write!

Learn more

More talks:

The Structure of Paclets by Connor Gray — Friday, 9:00am

Advanced Paclet Development (also) by Connor Gray — Friday 9:25am

Workshop:

Hands-on Paclet Development — Friday, 10:30am