Item198: Introduce marks and styleguides for topics in Foswiki (45min)

Priority:	CurrentState:	AppliesTo:	Component:	WaitingFor:
Normal	Confirmed	Web Site		Main.WillNorris

As a means to improve the content on our website, we deactivated the comment field. That is okay for me. But still conversations and long threats evolve, that make it difficult, to follow the discussion. But there are also other deficiencies in our topics.

That is, why I recommend, that we create a guideline for good content and create marks to show people, what should be changed on a page. The current English TWiki-page has such marks in Wikipedia:

Here are some more resources from Wikipedia, that show, how they deal with this issue:

• Category:Wikipedia style guidelines
• Category:General style guidelines
• Wikipedia:Manual of Style

First suggestions for marks in Foswiki

Topics that should be refactored

Use this template to mark the relevant topic:

Please refactor this page	This topic has a lot of unstructured content, that cannot be easily perceived by new readers. Please take some time to reorganize and edit the whole page.

Stubs: Topics that should be enhanced

Use this template to mark the relevant topic:

Please enhance this page	This topic has too little content. Please help to add more content. As long as it is a stub, we also appreciate keywords and unsorted notes.

---

Note that Wikipedia adds links to guides. This helps the prospect writer.

-- ArthurClemens - 16 Nov 2008 - 15:32

I suggest not using the word "refactor" (or "factor" and other variants). Although most programmers know by now what is meant by this term, it is not a term in general use and particularly for writing, does not add any additional semantic value over "reorganize" or just "rewrite". -- IsaacLin - 16 Nov 2008 - 17:53

---

changed "refactor" to "reorganize and edit" as reorganize captures the meaning of refactor better than rewrite (at least in this case)

-- WillNorris - 11 Apr 2009