designing documentation for developer products

14
Codeship Documentation https://codeship.io/documentation/

Upload: codeship

Post on 26-May-2015

3.119 views

Category:

Technology


2 download

DESCRIPTION

These slides belong to the original blog post on: http://blog.codeship.io/2014/09/11/designing-documentation-for-developer-products.html There are a few extremely important things to focus on when designing a Documentation for a Developer Product. Getting the correct information to the reader as quickly as possible is key. These slides by Codeship Support Engeneer Marko Locher explain how to create a quickly accessible, very readable and easily digestible documentation.

TRANSCRIPT

Page 1: Designing Documentation for Developer Products

Codeship Documentationhttps://codeship.io/documentation/

Page 2: Designing Documentation for Developer Products

Who is Marko?» Support Deckhand

@Codeship

» @mlocher on both, Twitter and GitHub

» Likes sailing, skiing and volleyball

Page 3: Designing Documentation for Developer Products

Old vs New

Page 4: Designing Documentation for Developer Products
Page 5: Designing Documentation for Developer Products
Page 6: Designing Documentation for Developer Products

Problems with old» Lots of visual clutter

» Search is hidden at the top

» Content doesn't stand out

Page 7: Designing Documentation for Developer Products

Goals» Use the search, Luke ;)

» Frictionless design

» Easy to contribute to

Page 8: Designing Documentation for Developer Products
Page 9: Designing Documentation for Developer Products

Use the search, Luke» Quickly find specific content

» Available on every page

» powered by Swiftype

Page 10: Designing Documentation for Developer Products
Page 11: Designing Documentation for Developer Products

No Distractions» Content is king!

» No unnecessary elements, sidebars…

» Focus on readability

Page 12: Designing Documentation for Developer Products

Technology Stack» Jekyll, a static site generator by the

folks at GitHub

» Rig, a CSS framework by Codeship

» Markdown

» Codeship, what else, for testing, building & deploying

Page 13: Designing Documentation for Developer Products

OpenSource» https://github.com/codeship/

documentation/

» MIT Licensed

See something that needs my attention? Message @mlocher on Twitter

Page 14: Designing Documentation for Developer Products

“Always keep shipping!”