Written Documentation

I have created documentation for MediaRadar as their technical writer. Much of it involved showing end users how to use software. However, the document below is a documentation best practices sheet. It is a document about writing documents. I wrote several of these as part of an initial project to make MediaRadar’s documentation consistent.

Documentation Best Practices

I also created documentation for Mozilla. I wrote pieces to show others how to use Firefox features. These two documents are for the Firefox iPhone app, Firefox for iOS, and the Firefox video chat feature, Firefox Hello.

Firefox for iOS

Firefox Hello

Also at Mozilla I created a training guide in which I teach volunteer technical writers how to write Mozilla Support articles. Here are some pieces from that training guide. These pieces show technical writers how to write articles on Mozilla Support, how articles should look, how to use proper language and tone, and how to create and add screenshots.

Writing a New Article

Style Guide

Adding Screenshots

 

2 thoughts on “Written Documentation

    • Nampiq, thank you so much. I’m so glad someone likes my blog. And thank you so much for the reminder to change the screenshots link. I meant to do that yesterday. I really appreciate the tip.

      Like

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google+ photo

You are commenting using your Google+ account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s