Re: [Sugar-devel] Google Season of Docs
A technical writer alone wouldn't be suitable hence we have a community for anything more that's needed and I think the idea is the technical writer could create a template of sorts that any teacher can base any of their lesson plans .etc. on as that seems easier as it enables the teacher setup what they want with a frame of reference. -- Ibiam Chihurumnaya ibiamchihurumn...@gmail.com On Tue, Feb 16, 2021 at 1:34 AM James Cameron wrote: > 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 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]qu...@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] > qu...@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
Re: [Sugar-devel] Google Season of Docs
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 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]qu...@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]qu...@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] > > > 2017...@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] > > > qu...@laptop.org > > > > > wrote: > > > > > > > > > > It's back. Can we win a slot this year? Ideas > > > welcome. > > > > > > > > > >
Re: [Sugar-devel] Google Season of Docs
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 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]qu...@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]qu...@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] > > 2017...@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] > > qu...@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@lists.sugarlabs.org > > > > > > [9][11][12]http://lists.sugarlabs.org/listinfo/sugar-devel > > > > > > > > ___ > > > > Sugar-devel mailing list > > > > [10][12][13]Sugar-devel@lists.sugarlabs.org > > > > [11][13][14]http://lists.sugarlabs.org/listinfo/sugar-devel > >