Question re. Contributor Guide

Hello All,

Just reflecting after the meeting today, re. Drew's presentation about "how
new contributors should on-board," I was curious about the progress of the
Contributors Guide. The Wiki (
https://wiki.documentfoundation.org/Documentation/Development/User_Guides)
mentions chapters being revised. During my explorations on NextCloud, I saw
that a newer Contributor Resources guide is in process.

Jean - I noticed that you are helping to write these. Is there anything you
need help with, by way of readthroughs or copyediting?

Cheers,
Sam

  Samantha Hamilton
  darling docs

  <https://darlingdocs.wordpress.com/> <https://github.com/samanthahamilton>
<https://www.linkedin.com/in/shamilton-64b4b71b0/>

Hello Samantha,

Thinking about new contributors, I'd like to make a suggestion.

I am under the impression that you are a technical writer, is that correct?
So, what do you feel about putting a really simple procedure-like
attachment in the Contributors Guide in order to direct the tasks for a
beginner?

It could be something very basic and clear, here's a little example for a
new reviewer:

"Step #1. Check if the cover is updated with the new template and version;
Step #2. Check if the number of pages is matching with the index;
Step #3. Check if all the dates are spelling part or all of the month
(According to Style Guide page 2)
... "

I don't know, just thought that it could help newcomers (just like myself)
starting in the tasks and give a relief for the more experienced and
professional ones, allowing them to focus on the advanced issues.

Please, everyone in the list, feel free to comment about that.

Best regards,
Felipe Viggiano

Filipe,

That sounds like a fun little project to write up. I am curious---do you
mean a newcomers reference guide for editing processes? like, "Ten things
to watch out for when reviewing," or a stepwise guide for newcomers
detailing what review projects are a good starting point (i.e., covers,
reference pages, etc.)?

Cheers,
Sam.

  Samantha Hamilton
  darling docs

  <https://darlingdocs.wordpress.com/> <https://github.com/samanthahamilton>
<https://www.linkedin.com/in/shamilton-64b4b71b0/>

Samantha,

I'm thinking in a very direct stepwise guide. Basically a checklist
instructing beginners in what's important to check in the documents.

With cautions to make sure the reader understands that the document
presents only some good starting points as you said, and feel free to check
for others discrepancies.

Best regards,
Felipe Viggiano

Hi Felipe,

It's unclear what you mean by "attachment in the Contributors Guide".
Most of the steps you outline are covered in the Contributor Guide.
After all these years the Contributors Guide (both document and wiki) is
still work in progress.

Not wishing to downgrade your idea, but now that there are finally an
almost reasonable number of team contributors and good progress being
made with the guides, what needs to be done is for the Documentation
Team to concentrate their efforts on completing the Contributors Guide
to sustain the momentum that has started in enlisting and supporting new
contributors. Drew's presentation is another useful move in this direction.

Years ago I pushed for this as part of the effort to engage new
contributors, but it never achieved the necessary traction. So please do
not waste the opportunity you have now.

Regards
Dave

NO! Please let us NOT have any "fun

        little" side projects. Over the years it has been difficult
      enough to just get the User Guides updated to match the current
      developer release. Now we have ALMOST enough worthwhile
      contributors to keep pace with updating the User Guides, so please
      let's not dilute that effort.Sorry I am just a nasty old ex-contributor.DaveBOn 17/07/2020 19:58, Samantha Hamilton wrote:
Filipe,

That sounds like a fun little project to write up. I am curious---do you
mean a newcomers reference guide for editing processes? like, "Ten things

to watch out for when reviewing," or a stepwise guide for newcomers
detailing what review projects are a good starting point (i.e., covers,
reference pages, etc.)?

Cheers,
Sam.

  Samantha Hamilton
  darling docshttps://darlingdocs.wordpress.com/https://github.com/samanthahamiltonhttps://www.linkedin.com/in/shamilton-64b4b71b0/>On Fri, Jul 17, 2020 at 2:20 PM Felipe Viggianofelipeviggiano@gmail.comwrote:Hello Samantha,

Thinking about new contributors, I'd like to make a suggestion.

I am under the impression that you are a technical writer, is that correct?
So, what do you feel about putting a really simple procedure-like
attachment in the Contributors Guide in order to direct the tasks for a
beginner?

It could be something very basic and clear, here's a little example for a

new reviewer:

"Step #1. Check if the cover is updated with the new template and version;
Step #2. Check if the number of pages is matching with the index;
Step #3. Check if all the dates are spelling part or all of the month
(According to Style Guide page 2)
... "

I don't know, just thought that it could help newcomers (just like myself)
starting in the tasks and give a relief for the more experienced and
professional ones, allowing them to focus on the advanced issues.

Please, everyone in the list, feel free to comment about that.

Best regards,
Felipe Viggiano

Em qui., 16 de jul. de 2020 às 16:33, Samantha Hamiltonsamanthahamilton0628@gmail.comescreveu:Hello All,

Just reflecting after the meeting today, re. Drew's presentation about"hownew contributors should on-board," I was curious about the progress oftheContributors Guide. The Wiki (https://wiki.documentfoundation.org/Documentation/Development/User_Guides)mentions chapters being revised. During my explorations on NextCloud, Isawthat a newer Contributor Resources guide is in process.

Jean - I noticed that you are helping to write these. Is there anythingyouneed help with, by way of readthroughs or copyediting?

Cheers,
Sam

  Samantha Hamilton
  darling docs

Hello Dave,

Sorry I didn't make myself clear enough. By "attachment in the Contributors
Guide", I meant in the form of an appendix (2 pages max.) at the end of the
book with some sort of starting guidance for beginners, no intention to
propose big changes in the document.
I just thought that it would be a good solution to standardize newcomers'
work on reviews.

But I understand and agree with your point of view, there is a lot of work
to do in more essential documents, and the team should be focused on
finishing these.

Best regards,
Felipe Viggiano

Felipe,

Thank you for the suggestion. As DaveB said, most of the list is
already in the Contributors Guide, but I think it could perhaps be
expanded and/or presented a bit differently. I’ll look at that when I
go through the guide making the latest corrections and updates.

Jean

Samantha,

Thanks for the nudge. Today I will go through the Contributors Guide
bringing in edits and updating things I know have changed since the
previous draft. After I do that, it will need to be reviewed again. I
will put the latest iteration in the Drafts folder for the guide and
let the list know when I've done that.

Jean