Best Practices

In this repo we outline the best practices for authors writing on the CircleCI blog.

Contents

1. Glossary

Screenshots

Guidelines for including (or not including) screenshots in tutorials and other developer documentation.

Links to other content providers' guidelines

Screenshot specific:

https://developer.rackspace.com/docs/style-guide/screenshots/screenshot-guidelines/

https://developer.gnome.org/gdp-style-guide/stable/infodesign-8.html.en#infodesign-10

Guidelines for writing procedures

https://www.digitalocean.com/community/tutorials/digitalocean-s-technical-writing-guidelines

https://docs.microsoft.com/en-us/style-guide/procedures-instructions/

https://developer.apple.com/design/human-interface-guidelines/macos/user-interaction/help/

When/why to include screenshots:

https://writing.stackexchange.com/questions/10643/when-is-a-screenshot-really-useful-in-training-documentation

Using Snagit to improve screenshots:

https://www.techsmith.com/tutorial-snagit-10-ways-to-make-better-visuals.html

Developer tutorials from other companies

https://material.io/resources/tutorials#android-java

https://www.digitalocean.com/community/tutorials