Hello all,
We recently released RoundCube (slightly modified) for a client of about 30 users.
They requested that I provide documentation in the form of a user guide for them.
I have already begun outlining the document. I began by looking at the instructions on the wiki, but then decided to just start from scratch.
My plan is this: 1 - Complete Outline of Document 2 - Flesh Out Content of Outline (Form Rough Draft) 3 - Will use the rough draft to generate a step-by-step screenshot/screencast utilizing "Wink" 4 - I will take the screen shots from Wink and insert them into the overall document. 5 - Will take key parts from the document and insert them into the Wink screencast and generate an SWF series of tutorials.
A portion of my time will be covered. Another portion will be "donated".
Once I have a fleshed out copy (step 2), I will probably put it online on the wiki or a google doc. At that point I would like to ask for any and all suggestions and corrections.
Wish me luck! :-P
Good portion of the outline is already completed. Overall operation of RC is outlined. Began outlining "Reading" of emails. Then just need to cover "Composing" and "Organizing" messages.
Well, that is all I have for now.
Kevin L.
Bez, if you would like to start it out on Google Docs and share it with me I could help you find project experts to help edit the document. Once it is mature I can copy the contents to the RC wiki.
It is nice to have on Google Docs because you can save the files out as a PDF and other formats your users may appreciate.
I also have a licensed copy of Camtasia, a commercial screencasting product which has a pretty nice editor. If your Wink recordings are compatible I may be able to help you refine your final product with callouts and a voiceover as well as jump points.
Instead of jump points though I prefer to keep each video very short and allow users to jump from page to page instead of jumping around in the flash document. I find it makes it easier to replace a section at a later point when a feature in the software you are documenting changes.
Brennan
On 2/6/07, Bez Support support@bezaleel.net wrote:
Hello all,
We recently released RoundCube (slightly modified) for a client of about 30 users.
They requested that I provide documentation in the form of a user guide for them.
I have already begun outlining the document. I began by looking at the instructions on the wiki, but then decided to just start from scratch.
My plan is this: 1 - Complete Outline of Document 2 - Flesh Out Content of Outline (Form Rough Draft) 3 - Will use the rough draft to generate a step-by-step screenshot/screencast utilizing "Wink" 4 - I will take the screen shots from Wink and insert them into the overall document. 5 - Will take key parts from the document and insert them into the Wink screencast and generate an SWF series of tutorials.
A portion of my time will be covered. Another portion will be "donated".
Once I have a fleshed out copy (step 2), I will probably put it online on the wiki or a google doc. At that point I would like to ask for any and all suggestions and corrections.
Wish me luck! :-P
Good portion of the outline is already completed. Overall operation of RC is outlined. Began outlining "Reading" of emails. Then just need to cover "Composing" and "Organizing" messages.
Well, that is all I have for now.
Kevin L.
Per Brennan's suggestion, I have created a Google Doc for the documentation I am writing.
If interested in editing or viewing, drop me a line.
Kevin L.
Brennan Stehling wrote:
Bez, if you would like to start it out on Google Docs and share it with me I could help you find project experts to help edit the document. Once it is mature I can copy the contents to the RC wiki.
It is nice to have on Google Docs because you can save the files out as a PDF and other formats your users may appreciate.
I also have a licensed copy of Camtasia, a commercial screencasting product which has a pretty nice editor. If your Wink recordings are compatible I may be able to help you refine your final product with callouts and a voiceover as well as jump points.
Instead of jump points though I prefer to keep each video very short and allow users to jump from page to page instead of jumping around in the flash document. I find it makes it easier to replace a section at a later point when a feature in the software you are documenting changes.
Brennan
On 2/6/07, Bez Support support@bezaleel.net wrote:
Hello all,
We recently released RoundCube (slightly modified) for a client of about 30 users.
They requested that I provide documentation in the form of a user guide for them.
I have already begun outlining the document. I began by looking at the instructions on the wiki, but then decided to just start from scratch.
My plan is this: 1 - Complete Outline of Document 2 - Flesh Out Content of Outline (Form Rough Draft) 3 - Will use the rough draft to generate a step-by-step screenshot/screencast utilizing "Wink" 4 - I will take the screen shots from Wink and insert them into the overall document. 5 - Will take key parts from the document and insert them into the Wink screencast and generate an SWF series of tutorials.
A portion of my time will be covered. Another portion will be "donated".
Once I have a fleshed out copy (step 2), I will probably put it online on the wiki or a google doc. At that point I would like to ask for any and all suggestions and corrections.
Wish me luck! :-P
Good portion of the outline is already completed. Overall operation of RC is outlined. Began outlining "Reading" of emails. Then just need to cover "Composing" and "Organizing" messages.
Well, that is all I have for now.
Kevin L.
I have attached a copy of the outline I worked on for the RoundCube documentation.
It is an outline along with a few notes. I think I have covered all the pertinent areas.
I would appreciate it if anyone that is willing would go through the document and make suggestions, etc.
There are some areas that I will need to verify how things work, etc.
I have included both a PDF and an ODT file.
Again, the document is currently on Google Docs. There are currently two others that have access to the document. If anyone else would like access to the Google Doc, just let me know.
I look forward to your replies.
Kevin L.
Bez Support wrote:
Per Brennan's suggestion, I have created a Google Doc for the documentation I am writing.
If interested in editing or viewing, drop me a line.
Kevin L.
Brennan Stehling wrote:
Bez, if you would like to start it out on Google Docs and share it with me I could help you find project experts to help edit the document. Once it is mature I can copy the contents to the RC wiki.
It is nice to have on Google Docs because you can save the files out as a PDF and other formats your users may appreciate.
I also have a licensed copy of Camtasia, a commercial screencasting product which has a pretty nice editor. If your Wink recordings are compatible I may be able to help you refine your final product with callouts and a voiceover as well as jump points.
Instead of jump points though I prefer to keep each video very short and allow users to jump from page to page instead of jumping around in the flash document. I find it makes it easier to replace a section at a later point when a feature in the software you are documenting changes.
Brennan
On 2/6/07, Bez Support support@bezaleel.net wrote:
Hello all,
We recently released RoundCube (slightly modified) for a client of about 30 users.
They requested that I provide documentation in the form of a user guide for them.
I have already begun outlining the document. I began by looking at the instructions on the wiki, but then decided to just start from scratch.
My plan is this: 1 - Complete Outline of Document 2 - Flesh Out Content of Outline (Form Rough Draft) 3 - Will use the rough draft to generate a step-by-step screenshot/screencast utilizing "Wink" 4 - I will take the screen shots from Wink and insert them into the overall document. 5 - Will take key parts from the document and insert them into the Wink screencast and generate an SWF series of tutorials.
A portion of my time will be covered. Another portion will be "donated".
Once I have a fleshed out copy (step 2), I will probably put it online on the wiki or a google doc. At that point I would like to ask for any and all suggestions and corrections.
Wish me luck! :-P
Good portion of the outline is already completed. Overall operation of RC is outlined. Began outlining "Reading" of emails. Then just need to cover "Composing" and "Organizing" messages.
Well, that is all I have for now.
Kevin L.
-
Bez Support -
Bezaleel Support
-
Brennan Stehling