Difference between revisions of "Checklist for Contributors"

Jump to navigation Jump to search
no edit summary
Line 50: Line 50:
{{checkbox}} Fix broken links — repair or delete broken links  
{{checkbox}} Fix broken links — repair or delete broken links  


=== Develop & write ===
=== Develop and write ===


Write new content when tweaking existing content won't do. Please consider:
{{checkbox}} Gaps — are there gaps in the content, is filling them crucial? <br/>
 
{{checkbox}} Plain language — keep the text simple and sentences short <br/>
{{checkbox}} Gaps — what is the gap in information and is filling it crucial? <br/>
{{checkbox}} Comprehension — edits should clarify meaning  
{{checkbox}} Plain language — keep your words simple and your sentences short (read about writing [http://www.plainlanguage.gov/whatisPL/definitions/Kimble.cfm tips], or try the online [http://www.hemingwayapp.com Hemingway App]). <br/>
{{checkbox}} Brevity — edits should clarify meaning, not add length <br/>
{{checkbox}} Organization — lists, subheadings and short paragraphs make reading easier and orient the reader <br/>
{{checkbox}} Organization — lists, subheadings and short paragraphs make reading easier and orient the reader <br/>
{{checkbox}} Legal references — would more citations benefit or just overwhelm the reader? <br/>
{{checkbox}} Legal references — would more citations benefit or just overwhelm the reader, are there too many cites already? <br/>


=== Simple & consistent ===
=== Simple & consistent ===
{{checkbox}} Clarify legal terms, include parenthetical definitions where needed <br/>  
{{checkbox}} Clarify legal terms include parenthetical definitions where needed <br/>  
{{checkbox}} Be consistent in word choice (e.g. choose either “renter” or “tenant”) <br/>
{{checkbox}} Consistency — be consistent in the terms you use <br/>
{{checkbox}} Familiarize yourself with and apply [[Clicklaw_Wikibooks_Style_Guide|Style Guide]]: <br/>
{{checkbox}} Familiarize yourself with and apply the [[Clicklaw_Wikibooks_Style_Guide|Style Guide]]: <br/>
:{{checkbox}} Correct [[Clicklaw_Wikibooks_Style_Guide#Emphasis|word emphasis]], [[Clicklaw_Wikibooks_Style_Guide#Acronyms|acronyms]], and [[Clicklaw_Wikibooks_Style_Guide#References|case citation style]] <br/>
:{{checkbox}} Correct [[Clicklaw_Wikibooks_Style_Guide#Emphasis|word emphasis]], [[Clicklaw_Wikibooks_Style_Guide#Acronyms|acronyms]], and [[Clicklaw_Wikibooks_Style_Guide#References|case citation style]] <br/>
:{{checkbox}} Apply [[Clicklaw_Wikibooks_Style_Guide#Lists|bullets/numbered lists]] and [[Clicklaw_Wikibooks_Style_Guide#Punctuation|punctuation]] <br/>
:{{checkbox}} Apply [[Clicklaw_Wikibooks_Style_Guide#Lists|bullets/numbered lists]] and [[Clicklaw_Wikibooks_Style_Guide#Punctuation|punctuation]] <br/>
{{checkbox}} Format neutral language — writing "See the chapter/page on…" is better than "Click here for information on…" since Wikibooks are also printed


== 3. Optional checklist ==
== 3. Optional steps ==


{{checkbox}} Is there extraneous information that should be removed? <br/>
{{checkbox}} Superfluous content — is there extraneous information that could be removed? <br/>
{{checkbox}} Is the overall language clear and approachable? <br/>
{{checkbox}} Clarity and tone — is the overall language clear and approachable? <br/>
{{checkbox}} Are there other Wikibooks pages that would be improved by linking to your content? Speak to that other editor
{{checkbox}} Cross links — are there other Wikibooks and other pages that would be improved by linking to your content?




Navigation menu