Hi all:
tl;dr We need your help! Please write Email articles #1, #2, #3 below and let us know you have done so by replying to this thread!
Here's a list of all the articles I have written so far for email:
And here's a list of articles I have written so far for camera:
Given the current state of the camera app, I am going to wait a few days before writing more camera content.
Good First KB Articles to write
Software developers have the concept of a good first bug so I thought I'd prepare a quick list of articles Good First KB Articles to write for email. The email app seems to be more mature or at least more comparable to existing email and therefore easy to write so I started there.
And I picked articles that are easy because you can just copy and paste and quickly modify an existing article.
Good First Articles for email
- flagging/bookmarking messages - just copy the text for Deleting email messages in Firefox OS and change the delete icon (search for [[Image:delete]]) to the one for bookmark namely [[Image:bookmark]]
- Moving Messages to folders - just copy the text for Deleting email messages in Firefox OS and change the delete icon (search for [[Image:delete]]) to the one for move namely [[Image:move icon]]
- Marking messages as read/unread - just copy the text for Deleting email messages in Firefox OS and change the delete icon (search for [[Image:delete]]) to the one for marking read namely [[Image:mark read]]
Resources for Writing Email Articles
It is quite possible to write KB articles just using the app wiki page and the visual and interaction PDFs. Ideally you'd also have the simulator working but it's not absolutely essential for the moment.
This is beta software so our articles will change, embrace change!'
I have been through many 1.0s, alphas and betas and the only thing they have in common is change. Embrace it :-) ! Expect it!
Icons will change, and flows will change but the more we document now the better. This is why we are keeping the articles short for now. Also don't post screenshots as these will change. If you want, leave a placeholder for screenshots now. I recommend writing articles that require the bare minimum of screenshots!
Hi all:
'''tl;dr We need your help! Please write Email articles #1, #2, #3 below and let us know you have done so by replying to this thread!'''
Here's a list of all the articles I have written so far for email:
* https://etherpad.mozilla.org/firefox-os-email-kb
And here's a list of articles I have written so far for camera:
* https://etherpad.mozilla.org/firefox-os-camera-kb
Given the current state of the camera app, I am going to wait a few days before writing more camera content.
'''Good First KB Articles to write'''
Software developers have the concept of a ''good first bug'' so I thought I'd prepare a quick list of articles ''Good First KB Articles to write'' for email. The email app seems to be more mature or at least more comparable to existing email and therefore easy to write so I started there.
And I picked articles that are easy because you can just copy and paste and quickly modify an existing article.
'''Good First Articles for email'''
# flagging/bookmarking messages - just copy the text for [[Deleting Messages]] and change the delete icon (search for <nowiki>[[Image:delete]]</nowiki>) to the one for bookmark namely <nowiki>[[Image:bookmark]]</nowiki>
# Moving Messages to folders - just copy the text for [[Deleting Messages]] and change the delete icon (search for <nowiki>[[Image:delete]]</nowiki>) to the one for move namely <nowiki>[[Image:move icon]]</nowiki>
# Marking messages as read/unread - just copy the text for [[Deleting Messages]] and change the delete icon (search for <nowiki>[[Image:delete]]</nowiki>) to the one for marking read namely <nowiki>[[Image:mark read]]</nowiki>
'''Resources for Writing Email Articles'''
* The Mac or Linux simulator for B2G is the best unless you happen to have a B2G device. The [http://people.mozilla.com/%7Emyk/r2d2b2g/ Mac add-on B2G simulator aka r2d2b3g by Myk Melez] is the best (should work on Linux, doesn't yet work on Windows). Eventually B2G desktop will start working again on Windows!
* The apps wiki page i.e. in this case the [https://wiki.mozilla.org/Gaia/Email] Gaia email wiki page is the next best resource
** Apps wiki pages link to the interaction and visual design mockups and these are secondary but well worth checking out e.g. [https://www.dropbox.com/sh/ygwfxk6chpshxdj/sunlK61ZrH/Apps/Email Email Interaction PDF] and [https://www.dropbox.com/sh/2tmvc7qyxmxba07/otjHdKf0kM Email Visual PDF]
It is quite possible to write KB articles just using the app wiki page and the visual and interaction PDFs. Ideally you'd also have the simulator working but it's not absolutely essential for the moment.
'''This is beta software so our articles will change, embrace change!''''
I have been through many 1.0s, alphas and betas and the only thing they have in common is change. Embrace it :-) ! Expect it!
Icons will change, and flows will change but the more we document now the better. This is why we are keeping the articles short for now. Also don't post screenshots as these will change. If you want, leave a placeholder for screenshots now. I recommend writing articles that require the bare minimum of screenshots!
