[Sugar-devel] Google Season of Docs

James Cameron quozl at laptop.org
Mon Feb 15 19:34:41 EST 2021


Thanks.  I agree.

Would a technical writer alone be suitable, or must a technical writer
be combined with a teacher?  There's a risk that by placing domain
specific limitations on the project, we make it harder for GSoD to
choose us.

What mode of delivery is best suited to teachers; written manuals,
lesson plans, onscreen walkthroughs, or stand up lectures?  There's a
risk that GSoD candidates will concentrate on written documentation.

How do we emphasise constructivism, constructionism, or constructivist
teaching methods?  Is there a degree or certification we can require?

On Mon, Feb 15, 2021 at 06:52:53PM -0500, Walter Bender wrote:
> Apologies for my late response to this thread.
> 
> Regarding documentation, I think we have a major hole to fill in
> Sugar, Music Blocks, and Sugarizer: supporting materials for teachers.
> While we have docs for the individual components, we could go a long
> ways towards giving some structure to a teacher who might want to
> build a comprehensive program out of any of our major subsystems.
> 
> -walter
> 
> On Wed, Feb 10, 2021 at 4:31 AM James Cameron <quozl at laptop.org> wrote:
> >
> > Yes.  Please make a list of content if none is available and content
> > that should be demystified?
> >
> > On Wed, Feb 10, 2021 at 10:07:45AM +0100, Samson Goddy wrote:
> > > Anyone can correct me if I am wrong. But the point of Season of Docs is
> > >
> > > 1. Generate content if none is available.
> > > 2. Very important is looking at the existing content and demystify it to the
> > > nearest minimum (Sugar Labs needs this)
> > >
> > > The idea for a technical writer is to simplify and transfer information between
> > > Sugar Labs and anyone consuming the content.
> > >
> > > To you, the content may look fine because you may not be the target, or in this
> > > case, you are an author of some of the tools generated.
> > >
> > > Having great doc is a demanding requirement for onboarding in open source, and
> > > unfortunately, I can't say Sugar Labs has one(simplifications).
> > >
> > > Also a completely different from GSoC.
> > >
> > > On Wed, Feb 10, 2021, 9:59 AM James Cameron <[1]quozl at laptop.org> wrote:
> > >
> > >     My first question was the most important.
> > >
> > >     I can't think of any documentation Sugar Labs needs that we haven't
> > >     already got in some form or other across our sprawling web presence.
> > >
> > >     I recommend against proceeding unless some documentation is needed.
> > >
> > >     On Wed, Feb 10, 2021 at 09:42:40AM +0100, Samson Goddy wrote:
> > >     > Hello James,
> > >     >
> > >     > I read the documentation, yes it looks like a grant based program this
> > >     time
> > >     > around.
> > >     >
> > >     > Just as I mentioned last year, I would love to admin the program, or be
> > >     one of
> > >     > the admins.
> > >     >
> > >     > I am working on a system in place already.
> > >     >
> > >     > Regards
> > >     >
> > >     > On Wed, Feb 10, 2021, 9:33 AM James Cameron <[1][2]quozl at laptop.org>
> > >     wrote:
> > >     >
> > >     >     Indeed.  So the question becomes;
> > >     >
> > >     >     - what documentation does Sugar Labs need (e.g. for Sugarizer, Music
> > >     >       Blocks, or Sugar); this forms part of a project proposal,
> > >     >
> > >     >     - who will recruit, evaluate, and onboard a technical writer?
> > >     >
> > >     >     - who will administer the program in Sugar Labs?
> > >     >
> > >     >     [2][3]https://developers.google.com/season-of-docs/docs/admin-guide
> > >     >
> > >     >     On Wed, Feb 10, 2021 at 08:48:21AM +0100, Favour Kelvin wrote:
> > >     >     > It is being organized differently this year; we have to apply for a
> > >     grant
> > >     >     and
> > >     >     > then we find the writer we reach out directly to the writer we want
> > >     to
> > >     >     work
> > >     >     > with, at least that is how I understood it.
> > >     >     >
> > >     >     > [1][3][4]https://opensource.googleblog.com/2021/02/
> > >     >     > the-2021-season-of-docs-application-for-organizations-is-open.html?
> > >     m=1
> > >     >     >
> > >     >     > [2][4][5]https://developers.google.com/season-of-docs/docs/
> > >     tech-writer-guide
> > >     >     >
> > >     >     > On Wed, 10 Feb 2021, 06:18 Saumya Mishra, <[3][5][6]
> > >     2017230 at iiitdmj.ac.in>
> > >     >     wrote:
> > >     >     >
> > >     >     >     I think it is a great idea. Sugar labs should take part in
> > >     GSoD.
> > >     >     >
> > >     >     >     Regards
> > >     >     >     Saumya Mishra
> > >     >     >
> > >     >     >     On Wed, Feb 10, 2021 at 7:05 AM James Cameron <[4][6][7]
> > >     quozl at laptop.org
> > >     >     > wrote:
> > >     >     >
> > >     >     >         It's back.  Can we win a slot this year?  Ideas welcome.
> > >     >     >
> > >     >     >         [5][7][8]https://opensource.googleblog.com/2021/02/
> > >     >     >
> > >     >      the-2021-season-of-docs-application-for-organizations-is-open.html
> > >     >     >         [6][8][9]https://developers.google.com/season-of-docs
> > >     >     >
> > >     >     >         --
> > >     >     >         James Cameron
> > >     >     >         [7][9][10]https://quozl.linux.org.au/
> > >     >     >         _______________________________________________
> > >     >     >         Sugar-devel mailing list
> > >     >     >         [8][10][11]Sugar-devel at lists.sugarlabs.org
> > >     >     >         [9][11][12]http://lists.sugarlabs.org/listinfo/sugar-devel
> > >     >     >
> > >     >     >     _______________________________________________
> > >     >     >     Sugar-devel mailing list
> > >     >     >     [10][12][13]Sugar-devel at lists.sugarlabs.org
> > >     >     >     [11][13][14]http://lists.sugarlabs.org/listinfo/sugar-devel
> > >     >     >
> > >     >     > References:
> > >     >     >
> > >     >     > [1] [14][15]https://opensource.googleblog.com/2021/02/
> > >     >     the-2021-season-of-docs-application-for-organizations-is-open.html?m=
> > >     1
> > >     >     > [2] [15][16]https://developers.google.com/season-of-docs/docs/
> > >     >     tech-writer-guide
> > >     >     > [3] mailto:[16][17]2017230 at iiitdmj.ac.in
> > >     >     > [4] mailto:[17][18]quozl at laptop.org
> > >     >     > [5] [18][19]https://opensource.googleblog.com/2021/02/
> > >     >     the-2021-season-of-docs-application-for-organizations-is-open.html
> > >     >     > [6] [19][20]https://developers.google.com/season-of-docs
> > >     >     > [7] [20][21]https://quozl.linux.org.au/
> > >     >     > [8] mailto:[21][22]Sugar-devel at lists.sugarlabs.org
> > >     >     > [9] [22][23]http://lists.sugarlabs.org/listinfo/sugar-devel
> > >     >     > [10] mailto:[23][24]Sugar-devel at lists.sugarlabs.org
> > >     >     > [11] [24][25]http://lists.sugarlabs.org/listinfo/sugar-devel
> > >     >
> > >     >     --
> > >     >     James Cameron
> > >     >     [25][26]https://quozl.linux.org.au/
> > >     >     _______________________________________________
> > >     >     Sugar-devel mailing list
> > >     >     [26][27]Sugar-devel at lists.sugarlabs.org
> > >     >     [27][28]http://lists.sugarlabs.org/listinfo/sugar-devel
> > >     >
> > >     > References:
> > >     >
> > >     > [1] mailto:[29]quozl at laptop.org
> > >     > [2] [30]https://developers.google.com/season-of-docs/docs/admin-guide
> > >     > [3] [31]https://opensource.googleblog.com/2021/02/
> > >     > [4] [32]https://developers.google.com/season-of-docs/docs/
> > >     tech-writer-guide
> > >     > [5] mailto:[33]2017230 at iiitdmj.ac.in
> > >     > [6] mailto:[34]quozl at laptop.org
> > >     > [7] [35]https://opensource.googleblog.com/2021/02/
> > >     > [8] [36]https://developers.google.com/season-of-docs
> > >     > [9] [37]https://quozl.linux.org.au/
> > >     > [10] mailto:[38]Sugar-devel at lists.sugarlabs.org
> > >     > [11] [39]http://lists.sugarlabs.org/listinfo/sugar-devel
> > >     > [12] mailto:[40]Sugar-devel at lists.sugarlabs.org
> > >     > [13] [41]http://lists.sugarlabs.org/listinfo/sugar-devel
> > >     > [14] [42]https://opensource.googleblog.com/2021/02/
> > >     the-2021-season-of-docs-application-for-organizations-is-open.html?m=1
> > >     > [15] [43]https://developers.google.com/season-of-docs/docs/
> > >     tech-writer-guide
> > >     > [16] mailto:[44]2017230 at iiitdmj.ac.in
> > >     > [17] mailto:[45]quozl at laptop.org
> > >     > [18] [46]https://opensource.googleblog.com/2021/02/
> > >     the-2021-season-of-docs-application-for-organizations-is-open.html
> > >     > [19] [47]https://developers.google.com/season-of-docs
> > >     > [20] [48]https://quozl.linux.org.au/
> > >     > [21] mailto:[49]Sugar-devel at lists.sugarlabs.org
> > >     > [22] [50]http://lists.sugarlabs.org/listinfo/sugar-devel
> > >     > [23] mailto:[51]Sugar-devel at lists.sugarlabs.org
> > >     > [24] [52]http://lists.sugarlabs.org/listinfo/sugar-devel
> > >     > [25] [53]https://quozl.linux.org.au/
> > >     > [26] mailto:[54]Sugar-devel at lists.sugarlabs.org
> > >     > [27] [55]http://lists.sugarlabs.org/listinfo/sugar-devel
> > >
> > >     --
> > >     James Cameron
> > >     [56]https://quozl.linux.org.au/
> > >
> > > References:
> > >
> > > [1] mailto:quozl at laptop.org
> > > [2] mailto:quozl at laptop.org
> > > [3] https://developers.google.com/season-of-docs/docs/admin-guide
> > > [4] https://opensource.googleblog.com/2021/02/
> > > [5] https://developers.google.com/season-of-docs/docs/tech-writer-guide
> > > [6] mailto:2017230 at iiitdmj.ac.in
> > > [7] mailto:quozl at laptop.org
> > > [8] https://opensource.googleblog.com/2021/02/
> > > [9] https://developers.google.com/season-of-docs
> > > [10] https://quozl.linux.org.au/
> > > [11] mailto:Sugar-devel at lists.sugarlabs.org
> > > [12] http://lists.sugarlabs.org/listinfo/sugar-devel
> > > [13] mailto:Sugar-devel at lists.sugarlabs.org
> > > [14] http://lists.sugarlabs.org/listinfo/sugar-devel
> > > [15] https://opensource.googleblog.com/2021/02/
> > > [16] https://developers.google.com/season-of-docs/docs/
> > > [17] mailto:2017230 at iiitdmj.ac.in
> > > [18] mailto:quozl at laptop.org
> > > [19] https://opensource.googleblog.com/2021/02/
> > > [20] https://developers.google.com/season-of-docs
> > > [21] https://quozl.linux.org.au/
> > > [22] mailto:Sugar-devel at lists.sugarlabs.org
> > > [23] http://lists.sugarlabs.org/listinfo/sugar-devel
> > > [24] mailto:Sugar-devel at lists.sugarlabs.org
> > > [25] http://lists.sugarlabs.org/listinfo/sugar-devel
> > > [26] https://quozl.linux.org.au/
> > > [27] mailto:Sugar-devel at lists.sugarlabs.org
> > > [28] http://lists.sugarlabs.org/listinfo/sugar-devel
> > > [29] mailto:quozl at laptop.org
> > > [30] https://developers.google.com/season-of-docs/docs/admin-guide
> > > [31] https://opensource.googleblog.com/2021/02/
> > > [32] https://developers.google.com/season-of-docs/docs/tech-writer-guide
> > > [33] mailto:2017230 at iiitdmj.ac.in
> > > [34] mailto:quozl at laptop.org
> > > [35] https://opensource.googleblog.com/2021/02/
> > > [36] https://developers.google.com/season-of-docs
> > > [37] https://quozl.linux.org.au/
> > > [38] mailto:Sugar-devel at lists.sugarlabs.org
> > > [39] http://lists.sugarlabs.org/listinfo/sugar-devel
> > > [40] mailto:Sugar-devel at lists.sugarlabs.org
> > > [41] http://lists.sugarlabs.org/listinfo/sugar-devel
> > > [42] https://opensource.googleblog.com/2021/02/the-2021-season-of-docs-application-for-organizations-is-open.html?m=1
> > > [43] https://developers.google.com/season-of-docs/docs/tech-writer-guide
> > > [44] mailto:2017230 at iiitdmj.ac.in
> > > [45] mailto:quozl at laptop.org
> > > [46] https://opensource.googleblog.com/2021/02/the-2021-season-of-docs-application-for-organizations-is-open.html
> > > [47] https://developers.google.com/season-of-docs
> > > [48] https://quozl.linux.org.au/
> > > [49] mailto:Sugar-devel at lists.sugarlabs.org
> > > [50] http://lists.sugarlabs.org/listinfo/sugar-devel
> > > [51] mailto:Sugar-devel at lists.sugarlabs.org
> > > [52] http://lists.sugarlabs.org/listinfo/sugar-devel
> > > [53] https://quozl.linux.org.au/
> > > [54] mailto:Sugar-devel at lists.sugarlabs.org
> > > [55] http://lists.sugarlabs.org/listinfo/sugar-devel
> > > [56] https://quozl.linux.org.au/
> >
> > --
> > James Cameron
> > https://quozl.linux.org.au/
> > _______________________________________________
> > Sugar-devel mailing list
> > Sugar-devel at lists.sugarlabs.org
> > http://lists.sugarlabs.org/listinfo/sugar-devel
> 
> 
> 
> -- 
> Walter Bender
> Sugar Labs
> http://www.sugarlabs.org

-- 
James Cameron
https://quozl.linux.org.au/


More information about the Sugar-devel mailing list