Request: Style guide for Wiki docs

General discussion about LÖVE, Lua, game development, puns, and unicorns.
Post Reply
pekka
Party member
Posts: 206
Joined: Thu Jan 07, 2010 6:48 am
Location: Oulu, Finland
Contact:

Request: Style guide for Wiki docs

Post by pekka » Fri Apr 09, 2010 5:54 pm

Could someone please write a detailed style guide for the documentation? So far, when editing the docs, I've just copied stuff and conventions from other pages and changed the relevant bits. This has resulted in some pages using different verb forms for describe a function. For example, somewhere it mostly says:

Draws a frobnit with frizzles.

And in other parts it often says:

Draw a frobnit with frizzles.

Naturally, I've copied both conventions to my own edits at different times. Whoops.

Recommendations for consistent markup, how to write synopses and examples would also be useful. Would anyone like to take a bit of time to write up a style guide and put it on the Wiki? I'd be happy to have some rules. I just don't want to come up with them by myself :)

User avatar
willurd
Citizen
Posts: 76
Joined: Thu Mar 04, 2010 1:04 am
Contact:

Re: Request: Style guide for Wiki docs

Post by willurd » Fri Apr 09, 2010 6:30 pm

One recommendation would be to make sure you re-read everything you write (at least once), to make sure that you are consistent with yourself first and foremost.

A style guide might be nice...but I'm not sure it needs to mention such things as proper verb forms.

User avatar
Thursdaybloom
Citizen
Posts: 81
Joined: Mon Feb 15, 2010 3:43 am
Location: Australia

Re: Request: Style guide for Wiki docs

Post by Thursdaybloom » Sat Apr 10, 2010 4:17 am

Pekka, feel free to write your own style guide for wiki. We can then refine it as a community.

Post Reply

Who is online

Users browsing this forum: No registered users and 55 guests