This page contains the details of a technical writing project accepted for Google Season of Docs.
Project summary
- Open source organization:
- Kaleidoscope
- Technical writer:
- techwriterjill
- Project name:
- Develop and improve the Kaleidoscope documentation
- Project length:
- Standard length (3 months)
Project description
As a writer, I'm very interested in this project. I currently use an ergonomic keyboard myself which does not have the capabilities of the Kaleidoscope Model 01, but my familiarity with a split/tented keyboard layout will help me in the initial stages when testing and exploring the functions of the firmware. My experience as a user of similar products will also assist me to identify the product features and documentation that fellow users find helpful.
I am experienced in documenting the installation and configuration of complex products and very much enjoy this type of work. I also like getting ""hands on"" (which will be quite literal in this case) with products and processes to become familiar with them, in order to write about them. I believe this enables me to produce quality documentation that is of real value to users.
Prior to becoming a dedicated technical writer I worked as a support analyst which has provided invaluable skills that I would use for this project, such as compiling code, testing, investigating and replicating problems.
I have made initial contact with Jesse and Gergely at Kaleidoscope and we have made a tentative plan that, if accepted, I could work on the following projects which they have identified as being the most valuable to their users:
- Document the hardware plugins
- Document how to write macros for the novice user
- Write an overview of the available plugins
I work full time so I would be able to commit around 10 hours per week during the Season of Docs period. This may allow me to complete more small projects in addition to the above. When researching Kaleidoscope I noticed that the only user-friendly description of the product is on the Kickstarter page. The initial crowdfunding project ended in 2015 so I think a user focussed website is needed. I'm not a web developer but I would be happy to contribute ideas and text for the website, if this is something Kaleidoscope is interested in pursuing.
Jesse and Gergely have offered to send a keyboard to the successful writer and I think that this will be instrumental in the success of the project.
I believe that my skills and experience make me an ideal candidate for this project and I look forward to hearing from you.