|
| 1 | +.. _GSoD2021_call_writers: |
| 2 | + |
| 3 | +================================================== |
| 4 | +:index:`GSoD : Technical Writer Selection Process` |
| 5 | +================================================== |
| 6 | + |
| 7 | +Thank you for your interest in creating technical documentation for `scancode.io <https://github.com/nexB/scancode.io>`_. |
| 8 | + |
| 9 | + |
| 10 | +OUR EXPECTATIONS |
| 11 | +---------------- |
| 12 | + |
| 13 | +Technical Writing Experience |
| 14 | +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 15 | + |
| 16 | +You should have been actively writing technical documentation, and have multiple publicly |
| 17 | +available samples of your work. |
| 18 | + |
| 19 | +Familiarity with scancode.io |
| 20 | +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 21 | + |
| 22 | +You will need to learn how scancode.io works, its functions and features in order to write |
| 23 | +effective and useful technical documentation. We currently have some basic documentation at |
| 24 | +`scancodeio.readthedocs.io <https://scancodeio.readthedocs.io/en/latest/>`_. |
| 25 | + |
| 26 | +You will also need to know or learn the key concepts of Software Composition Analysis in order |
| 27 | +to understand your audience. You will have access to a nexB instance of scancode.io, but you will |
| 28 | +also need to be able to install and run scancode.io locally on your own computer. |
| 29 | + |
| 30 | +Familiarity with Sphinx, RTD, git/GitHub |
| 31 | +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 32 | + |
| 33 | +You should have experience writing documentation in a Sphinx/reStructuredText environment where |
| 34 | +the documentation is managed side by side with the code in a GitHub project repository. We treat |
| 35 | +technical documentation like code, tested for successful builds and checked with linters for |
| 36 | +quality control. |
| 37 | + |
| 38 | +Eagerness to learn about and document scancode.io |
| 39 | +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 40 | + |
| 41 | +We expect you to try scancode.io out yourself and familiarize yourself with it, and to be eager |
| 42 | +to learn and document all aspects of it, particularly the How-To Guides and Tutorials. |
| 43 | + |
| 44 | +Here are some suggestions for you to consider as documentation topics: |
| 45 | + |
| 46 | +- Did you encounter any difficulties installing scancode.io locally? Assuming that you resolved |
| 47 | + them, can you improve the documentation to help others? |
| 48 | +- Do you understand how the pipelines work? How would you explain pipelines to others in greater |
| 49 | + detail? |
| 50 | +- Do you understand how to interpret and get full value from scan results? How would you document |
| 51 | + ways to get the most out of the scan results? |
| 52 | + |
| 53 | +We use `Diataxis <https://diataxis.fr/>`_ - as a design framework for our documentation. |
| 54 | + |
| 55 | +.. note:: |
| 56 | + |
| 57 | + Reach out to us if you have any specific questions on setting up and using scancode.io locally |
| 58 | + or in general. `Link to Gitter Chat <https://gitter.im/aboutcode-org/gsod-season-of-docs/>`_ |
| 59 | + |
| 60 | + |
| 61 | +STATEMENT OF INTEREST |
| 62 | +--------------------- |
| 63 | + |
| 64 | +Applicants are expected to submit a Statement of Interest [`GSoD Official Template <https://developers.google.com/season-of-docs/docs/tech-writer-statement>`_] |
| 65 | +as a publicly viewable document, preferably in Google Docs, to pombredanne@nexb.com. |
| 66 | +[CC to dmclark@nexb.com and asmahapatra@nexb.com] |
| 67 | + |
| 68 | +It should have the following minimum sections: |
| 69 | + |
| 70 | +- `Personal Information <https://developers.google.com/season-of-docs/docs/tech-writer-statement#personal_information>`_ |
| 71 | +- `Professional Information <https://developers.google.com/season-of-docs/docs/tech-writer-statement#professional_information>`_ |
| 72 | +- `Project Details <https://developers.google.com/season-of-docs/docs/tech-writer-statement#project_statement>`_ |
| 73 | + |
| 74 | +.. note:: |
| 75 | + |
| 76 | + Note that you do not need to suggest a budget, nor do you have to suggest a timeline. Both are specified in our organisation proposal linked below. |
| 77 | + |
| 78 | + - Budget: $15,000 |
| 79 | + - Timeline: 18 May to 22 October [`GSoD Timeline <https://developers.google.com/season-of-docs/docs/timeline>`_] |
| 80 | + |
| 81 | +IMPORTANT DATES |
| 82 | +--------------- |
| 83 | + |
| 84 | +- 10 May : Deadline to Submit Statement of Interest |
| 85 | +- 16 May : We announce our selection |
| 86 | +- 17 May 18 PM UTC : Google Season of Docs Technical Writing Hiring Deadline |
| 87 | + |
| 88 | +LINKS |
| 89 | +----- |
| 90 | + |
| 91 | +- `Organisation Proposal <https://docs.google.com/document/d/1jW2ogyALIBNsVpHhQ0EbBKzpfPF8BJzmT4vCfU3sQso/edit?usp=sharing>`_ |
| 92 | +- `Gitter Chat <https://gitter.im/aboutcode-org/gsod-season-of-docs>`_ |
| 93 | +- `Scancode.io GitHub Repository <https://github.com/nexB/scancode.io>`_ |
| 94 | +- `Scancode.io RTD Documentation <https://scancodeio.readthedocs.io/en/latest/>`_ |
0 commit comments