Stream: Google Season of Docs

Topic: proposal

Sahibpreet Kaur (Jun 27 2019 at 12:06):

Hi everyone,
I am interested in the project "Documentation that specifically caters to new users" for GSoD. I am working on the proposal as well. I have been writing my proposal based on points like these:
- How will this documentation help new users who are not only new to BRL-CAD but might also be new to open-source.
- How this documentation must be structured so that new users know where they are headed and what they are doing.
- How to make the new users feel at ease and not get overwhelmed by the big words.
- Make sure that documentation showcases the real power of BRL-CAD and what various things users can do using it.

Is there anything else that must be included beside these points?

Sean (Jun 27 2019 at 13:05):

hello @Sahibpreet Kaur It's technically your proposal, so it only must include the points you feel it must include. The points you listed sound good on the surface. I would also be interested in the process -- how do you go about writing documentation that fulfills those points, can you prove in some way that they do (beyond saying "it does"), how do you measure quality, etc.

Sahibpreet Kaur (Jun 27 2019 at 17:40):

hello Sahibpreet Kaur It's technically your proposal, so it only must include the points you feel it must include. The points you listed sound good on the surface. I would also be interested in the process -- how do you go about writing documentation that fulfills those points, can you prove in some way that they do (beyond saying "it does"), how do you measure quality, etc.

@Sean Thanks for the reply. It surely gave me a head start. I will make sure to explain what exactly am I going to do in order to fulfill those points. :big_smile:

Last updated: Jan 10 2025 at 00:48 UTC