On Sunday 25 November 2018 17:36:16 Ingo Schwarze wrote:
> Stephen Gregoratto wrote on Mon, Nov 26, 2018 at 12:26:21AM +1100:
> >
> > Would I need to fully grok the code before I could write the docs?
>
> Absolutely not. You could spend an infinite amount of time to
> understand the code if you tried to understand everything.
> Of course, there is nothing wrong with studying whatever interests
> you.
In addition to what Ingo has already said, I would add that I think it is
actually beneficial for someone who is not highly familiar with the code to
write the documentation, as it gives you a fresh set of eyes and a different
perspective. You'll question and challenge things rather than accepting them
at face value. However, you obviously you need to at least be able to read the
code to generally understand what it is doing.
Furthermore, I'd suggest that you start small (fix some typos, correct some
gramatical issues) and then work up to bigger changes (rewriting poorly
written documentation or creating new man mages). This will let you become
familiar with the documentation style and review/commit process, with faster
reviews and feedback.
No comments:
Post a Comment