This document defines the scope of work requested by the Yocto Project for a Technical Documentation person . The document specifies the required timelines and deliverables. The information provided in this document should be used to provide quotation for the required tasks

Background

The Yocto Project is looking to expand its capacity and maintain its reputation for quality. To do this we believe that assistance in specific areas would be beneficial and ensure key tasks have people dedicated to performing them. As such the Yocto Project is looking for additional resources in these areas.

Scope of work

The work to be accomplished under this RFQ is to assist the Yocto Project in developing and maintaining the many documents the Project supplies the greater community.

The key tasks which make the scope of this RFQ are:

• Update and maintain the project’s documentation day to day:
  • Review and merge patches
  • Identify where changes are required due to development changes or new features
  • Continual improvement & expansion of existing documentation
• Create and release the documentation alongside project releases. These include:
  • Release notes
  • Migration guides
  • Quick start guides
  • Reference manuals
  • Developer guides
• Verify procedures in the documents (including running tests of these, potentially automating)
• Ensure documentation technologies match current best practices
• Occasional help with editing/review of whitepapers, blog, website or PR material and other project writing for publication

Given the nature of the work it is not possible to predict the workload at any given time or what timezone these events occur.

Requirements

As part of this RFQ, the Yocto Project expects to build a long term relationship with this technical documentation person. The project leadership team estimates that the workload for this role should be no more than fifty percent (50%) of a full time role. Given the nature of the work, the project expects that the workload will be spread evenly throughout the year.

In addition, the quotation should include evidences that the proposed candidate has the following skills and experience:

• Creating documentation in Sphinx
• Worked on Software manuals in OpenSource with Open Source project contributions.
• Excellent English written and verbal communication skills
• Product release documentation
• Comfortable with communicating via email and IRC
• Working knowledge of git
• Worked with html or other web technologies
• Worked on creating On-line Documents
• Knowledge of docbook advantageous
• Able to test out procedures as documented
• Able to work on multiple release versions at once
• Experience with OpenEmbedded/Yocto Project advantageous
• Able to work with a diverse open source community of contributors.
• Has basic experience with Python programming and shell scripts.
• Working knowledge of the Bugzilla
• 5 years documentation maintenance experience

Quotation

While the general intention that the whole scope of work as defined in the section “Scope of work” is to be accomplished by the contractor, the Yocto Project will maintain the right to exit the contract at the end of each quarter. The response to this RFQ is expected to provide the quotation for the development tasks defined in “Scope of work”.

Please send quotations to jobs@yoctoproject.org.