[OH-Dev] documentation decisions

[Carol Willing]

I agree with Asheesh on readability:)

Shauna, I like the guide and the direction it takes. Good documentation 
helps everyone. It's a huge help for the quieter, less assertive 
contributor (or someone facing imposter syndrome) since it gives that 
person the ability to have small successes with less risk of "looking 
stupid" for not understanding a simple step that "everyone else" 
understands.

Keep up the good energy and momentum on docs. I'm happy to help as I am 
able :)

Carol

On 11/8/13 12:03 AM, Asheesh Laroia wrote:
> Dear everyone, especially Shauna Gordon-McKeon for starting this thread,
>
> I took a fresh look at the http://openhatch.readthedocs.org/en/latest/
> page earlier today for some reason, and was suddenly shocked and
> impressed by how much more readable they seem to be today than they
> were a few days ago.
>
> The new organization that has already landed (commits by Shauna) seem
> to make a huge difference to me.
>
> I would LOVE if other people are willing to take a look at it and see
> what they think as well.
>
> On Thu, Nov 7, 2013 at 4:26 PM, Shauna Gordon-McKeon <shaunagm at gmail.com> wrote:
>> Asheesh and I had an IRC meeting re: documentation today.
>>
>> We decided the following:
>> 1) what our goals for documentation are
>> 2) a new structure
>> 3) a plan for implementing the new structure
>>
>> You can see #1 and #2 at this etherpad:
>> https://etherpad.mozilla.org/OH-documentation-meeting-results
>>
>> The plan for implementing the new structure is for Asheesh to lead a
>> "documentation party" sometime in the next few weeks.  We'll announce that
>> here, but in the mean time let us know if you want to be involved so we can
>> try to take your schedule into account.
>>
>> One final note: this documentation push was inspired by a "guide for open
>> source projects" that I've been writing (see here:
>> https://docs.google.com/document/d/1UGtR_6XWBn4_vo37Kn_hNXmzpwLaSJEZxc8rqFKhy-U/edit).
>> Documentation is a big part of helping newcomers contribute to open source,
>> and I want to make sure OpenHatch has exemplary documentation!
>>
>> ~ Shauna
>>
>> _______________________________________________
>> Devel mailing list
>> Devel at lists.openhatch.org
>> http://lists.openhatch.org/mailman/listinfo/devel
>>
> _______________________________________________
> Devel mailing list
> Devel at lists.openhatch.org
> http://lists.openhatch.org/mailman/listinfo/devel


-- 
Carol Willing
Developer
Willing Consulting