Moodle documentation: Getting started writing MoodleDocs

Moodle documentation: Getting started writing MoodleDocs

by Mark Drechsler -
Number of replies: 5

Hi all,

Hopefully an easy question - is there any documentation floating around on how someone new to MoodleDocs can start to document features? Thinking both from the 'nuts and bolts' of editing the wiki through to the writing guidelines they should use.

Thoughts welcome smile

Mark.

Average of ratings: -
In reply to Mark Drechsler

Re: Moodle documentation: Getting started writing MoodleDocs

by Tim Hunt -
Picture of Core developers Picture of Documentation writers Picture of Particularly helpful Moodlers Picture of Peer reviewers Picture of Plugin developers
In reply to Tim Hunt

Re: Moodle documentation: Getting started writing MoodleDocs

by Mark Drechsler -

Thanks Tim,

I reckon http://docs.moodle.org/20/en/MoodleDocs:Guidelines_for_contributors is the one I was after. Sorted!

Mark.

In reply to Mark Drechsler

Re: Moodle documentation: Getting started writing MoodleDocs

by Visvanath Ratnaweera -
Picture of Particularly helpful Moodlers Picture of Translators
Last but not least, the forum " Moodle documentation" http://moodle.org/mod/forum/view.php?id=5838
In reply to Visvanath Ratnaweera

Re: Moodle documentation: Getting started writing MoodleDocs

by Helen Foster -
Picture of Core developers Picture of Documentation writers Picture of Moodle HQ Picture of Particularly helpful Moodlers Picture of Plugin developers Picture of Testers Picture of Translators

Mark, great to hear you're planning on helping write documentation. approve New contributors are always welcome.

You'll notice from http://docs.moodle.org/20/en/Special:RecentChanges that the wiki is currently undergoing a major clean-up and reorganisation but please don't let that put you off contributing! Simply add documentation of new features wherever you think is appropriate. Alternatively you're welcome to choose a page from http://docs.moodle.org/20/en/Category:Pages_needing_improvement to work on.

Regarding writing guidelines, glad you found MoodleDocs:Guidelines for contributors. However, on my to-do list (somewhere!) is to expand on these guidelines and explain how Moodle Docs is organised these days.

As Tomaz mentioned in his post Update on Moodle 2.0 Docs, previously the teacher and administrator documentation was kept quite separate, whereas from the 2.0 docs onwards, we're aiming to keep all documentation about a particular feature in one place. Thus, for example, when a teacher adds a forum to their course and checks the Forum settings documentation, they can also read about any site administration settings relating to it. Similarly, an administrator can read about course administration settings.

Finally, as Visvanath mentions, the Moodle documentation forum is a great place for discussing these things, so I'm just going to move this thread there...

In reply to Helen Foster

Re: Moodle documentation: Getting started writing MoodleDocs

by Visvanath Ratnaweera -
Picture of Particularly helpful Moodlers Picture of Translators
Hi Helen

> as Visvanath mentions, the Moodle documentation forum is a great place for discussing

Did I say that?

I had a different impression. I've rechecked my short carrier at the "Moodle documentation" forum: http://moodle.org/mod/forum/search.php?search=forumid%3A827%20user%3AVisvanath&id=5&perpage=20

The start http://moodle.org/mod/forum/discuss.php?d=176040 was promising. Then went stale http://moodle.org/mod/forum/discuss.php?d=176065#p776797 then questionable http://moodle.org/mod/forum/discuss.php?d=176065#p776437 and http://moodle.org/mod/forum/discuss.php?d=176065#p779435 to end up in a disaster http://moodle.org/mod/forum/discuss.php?d=182081#p793651 at which point I dicided to unsubscribe and move on to more useful things.

Going through those discussions other related discussions like:
- http://moodle.org/mod/forum/discuss.php?d=178285
- http://moodle.org/mod/forum/discuss.php?d=182903 (ok, a single posting yet)
- http://moodle.org/mod/forum/discuss.php?d=177060
- http://moodle.org/mod/forum/discuss.php?d=181256 (again a single posting)
- http://moodle.org/mod/forum/discuss.php?d=149845
- http://moodle.org/mod/forum/discuss.php?d=169322
I feel confirmed in my decision.

P.S. @all, I read read this forum only occasionally.