LUV Main April 2018 Meeting: Write docs like a software developer using the Linux toolchain

Apr 3 2018 18:30
Apr 3 2018 20:30
Location: 
Kathleen Syme Library, 251 Faraday Street Carlton VIC 3053

PLEASE NOTE NEW LOCATION

Tuesday, April 3, 2018

6:30 PM to 8:30 PM
Kathleen Syme Library, 251 Faraday Street Carlton VIC 3053

Speakers:

  • Alec Clews, Write docs like a software developer using the Linux toolchain

This talk is about public API documentation and what useful developer documentation should look like. The bulk of the presentation will demonstrate various UNIX/Linux style CLI tools (M4, Make, Plantuml, Pandoc, Graphviz, ...) and how they can be part of a build chain to keep your docs up to date and relevant. There will also be a discussion on why this toolchain is used, instead of tools like Javadoc or Swagger.

The material is based on a short talk given at LCA 2018 'Using "old skool" Free tools to easily publish API documentation'

Alec Clews founded Melbourne Raspberry Jam. He can be found online as alecthegeek in to many places. He drinks too much espresso, uses Linux as much as possible and wishes he was a better Go programmer.

Linux Users of Victoria is a subcommittee of Linux Australia.

Comments

Post new comment

The content of this field is kept private and will not be shown publicly.
  • Allowed HTML tags: <a> <b> <dd> <dl> <dt> <i> <img> <li> <ol> <u> <ul> <pre> <br> <blockquote> <hr> <code><sup><sup><p><em><strong> <h2> <cite> <code> <tt> <h1><table><tr><th><td>
  • Lines and paragraphs break automatically.

More information about formatting options

CAPTCHA
This question is for testing whether you are a human visitor and to prevent automated spam submissions.