[SeasonOfDocs] Proposed guidelines for selecting a paid contributor

Thu May 9 04:54:11 PDT 2019

Hi,

I'm not so sure we want someone who knows about the software, the code and
the command line. We want to write a documentation that is understandable
by everyone, right? So someone who has little or no idea about this can be
also helpful from that perspective.

They need to know about Git and Github to be able to write and push the
documentation.

On Thu, May 9, 2019 at 1:25 PM Cameron Shorter <cameron.shorter at gmail.com>
wrote:

> Thanks for the suggestions Jo. I've updated to:
>
> * It will be helpful if you understand the basics of software development,
> including:
> **  Installing software on Linux, windows and mac, from the command line
> ** Using basic git and github functionality to update documentation
> ** Writing in wiki, markdown and restructured text formats
> ** Bonus points if you can read code and understand it
> On 9/5/19 9:00 pm, Jo Cook wrote:
>
> Hi Cameron,
>
> I think the only area of that list that I think needs some work is the
> section on software development.
>
> * You can install software on linux, windows and mac from the command line
> Yes, this makes sense- we need to highlight differences between
> installation methods
>
> * You understand basic git commands
> What did you have in mind here- is this for committing documentation to
> github? I think this needs expanding a bit- people need to be familiar with
> using git and github
>
> * You can read code and understand it
> As it stands, this would put me off as I always think of myself as a
> non-coder. Could we expand it to say "understand it enough to follow an
> instruction through or track down where an issue occurs". Otherwise what
> did you have in mind for this point?
>
> * You are comfortable writing in wiki formats
> Wiki, and markdown, restructured text
>
> All the best
>
> Jo
>
> On Thu, May 9, 2019 at 9:19 AM Cameron Shorter <cameron.shorter at gmail.com>
> wrote:
>
>> Hi folks,
>> I've taken a first cut at what I think we should use as guidelines for
>> selecting our paid contributors. I'd be interested to hear feedback. Are
>> there other things we should be considering?
>> --
>>
>> https://wiki.osgeo.org/wiki/Season_of_Docs_Ideas_2019#Selection_criteria_for_paid_role
>>
>> For the paid senior technical writer role
>> <https://developers.google.com/season-of-docs/docs/tech-writer-guide>,
>> we are looking for someone to help us reach our goals of being impactful,
>> sustainable and effective. In responding, consider:
>>
>>    - How will your contributions be valuable beyond the SeasonOfDocs
>>    period, beyond the initiative you take on, beyond the specific project(s)
>>    you help?
>>    - How will you be helping others become more effective? Look at
>>    profiles of volunteers interested so far.
>>    - We have technical expertise. We are looking for someone with a
>>    breadth and depth of writing experience. You are familiar with various
>>    style guides, writing styles, information design, writing tools, etc.
>>    You’ll have opinions on which should be used and why and will help shape
>>    our communication strategies.
>>    - Will you be able to help us find and then become involved in best
>>    practice documentation communities? You might already be part of such
>>    communities.
>>    - You are nice and friendly, in line with our code-of-conduct
>>    <https://www.osgeo.org/code_of_conduct/>.
>>    - You know the basics of software development:
>>       - You can install software on linux, windows and mac from the
>>       command line
>>       - You understand basic git commands
>>       - You can read code and understand it
>>       - You are comfortable writing in wiki formats
>>    - Google offers standard-length (3 months) and long-running (6
>>    months) options (for the same stipend funds). The longer timeframe is
>>    better suited to working with volunteers and our goal of sustainability.
>>    - It will be challenging for us to have the bandwidth to assess
>>    whether you are both competent and will sustain your involvement long term.
>>    Are you able to reference your volunteer involvement in other communities?
>>    How can you concisely reference your communication expertise?
>>
>> Does all this sound exciting, but you suspect you don’t have the
>> bandwidth or expertise for the paid senior technical writer role? Why not
>> join our volunteers?
>>
>>
>> --
>> Cameron Shorter
>> Technology Demystifier
>> Open Technologies and Geospatial Consultant
>>
>> M +61 (0) 419 142 254
>>
>>
>>
>> _______________________________________________
>> SeasonOfDocs mailing list
>> SeasonOfDocs at lists.osgeo.org
>> https://lists.osgeo.org/mailman/listinfo/seasonofdocs
>>
>
>
> --
> ------------------------
> http://about.me/jocook
>
> --
> Cameron Shorter
> Technology Demystifier
> Open Technologies and Geospatial Consultant
>
> M +61 (0) 419 142 254
>
> _______________________________________________
> SeasonOfDocs mailing list
> SeasonOfDocs at lists.osgeo.org
> https://lists.osgeo.org/mailman/listinfo/seasonofdocs
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/seasonofdocs/attachments/20190509/09238ec7/attachment-0001.html>