Line #48 Administrivia/HowToWriteAnExample


1	If tropes are the "meat" of Website/TVTropes, examples are the potatoes, sides, sauces and condiments that give that meat both substance and flavor. A list of tropes with descriptions and clever names is all well and good, but examples bring articles to life, flesh out readers' understanding of tropes, and showcase the many ways a single trope can be used.
2
3	Given all that, it's important that our examples be as readable, informative, and interesting to as many readers as possible. To that end, we've come up with a list of guidelines and best practices to keep in mind when adding examples to pages.
4
5	While the size of this list may seem intimidating, please remember that very few of these "rules" are completely unique to TV Tropes. Most of them are about the characteristics of good writing in general: clear, concise, organized, and informative. Likewise, if you've spent time reading the wiki, you probably have a decent enough idea of what an example is expected to look like. These guidelines are about ''refining and improving'' your example writing, not boxing you into a boring, uniform writing style.
6
7	Other relevant information can be found at the following pages:
8	* '''Information on Text Formatting and Markup:''' Administrivia/TextFormattingRules
9	* '''Guidelines for Indenting and Ordering Examples:''' Administrivia/ExampleIndentationInTropeLists
10	* '''Guide to General Wiki-Editing Behavior:''' Administrivia/TVTropesCustoms
11
12	For an actual ''example'' of everything on this list (and about 3,000 screwups that ''aren't''), see DarthWiki/HowNotToWriteAnExample.
13
14	[[foldercontrol]]
15
16	----
17
18
19	!The First Rule:
20
21	* '''[[Administrivia/ClearConciseWitty Remember that the point of an example is to convey information]].''' Clarity is the most important quality of any example. "Clever" is nice, "Funny" is nice, "Detailed" is nice. But if any of these get in the way of ''clarity'', they cease being nice additions and become a problem.\
22
23
24	!All-Purpose Advice:
25
26
27	[[folder:General Guidelines]]
28
29	* '''Aim For "Final Draft" Quality:''' Simply adhering to this concept will serve you well throughout your troping career, regardless of what you're doing or where. \
30
31	* '''Include the Full Name of the Work or Trope:''' Every example on a trope page should either include the name of the work or be placed under the work's entry as a secondary bullet point. Likewise, every trope on a work page should be organized under its name in alphabetical order. You ''do'' want the reader to know which work or trope you're talking about, right?\
32
33	* '''Write for a General Audience:''' Readers should be able to understand your example regardless of their age, place of origin, or if they're reading this several years from now.
34	** Keep the fan terms and jargon to a bare minimum. Not everyone is familiar with every fandom's terminology. This includes avoiding CharacterizationTags (e.g. dark!Harry, 2012!Hulk), unless the work itself uses them.
35	** Don't use the hottest new slang. Most trendy slang terms fall out of use before long, and future readers shouldn't need an interpreter or a historical slang website to understand you.
36	** Don't use Internet acronyms. Not everyone knows what they mean, and it makes your writing look lazy. Also, like slang, they fall into disuse and thus may be hard to understand in the future.
37
38	** Don't use acronyms for work names (e.g. don't use LOTR for ''Lord of the Rings''); write them out. If you've already used the full name of the work in your entry, you can abbreviate it on subsequent uses, e.g. ''Order of the Phoenix'' for ''Literature/HarryPotterAndTheOrderOfThePhoenix''.
39	** Don't refer to {{meme\|ticMutation}}s unless it's actually part of the example. No meme is popular or funny forever, and using such inside jokes is tacky at best.\
40
41	* '''Keep it Brief:''' Administrivia/BrevityIsWit. No one wants to read WallsOfText. Examples should have enough substance that readers can get a clear picture of how a work uses a trope, ''and no more.'' As a general rule, if your example is longer than a medium-sized paragraph, it's too long.\
42
43	* '''... [[Administrivia/ZeroContextExample But Not Too Brief]]:''' Remember, an example is exactly that: ''an example''. With the specific exceptions of a select few TitleTropes, there is no such thing as an example that doesn't need to be explained or given context. On TV Tropes, '''context is key'''.\
44
45	* '''Stay on Topic:''' Don't switch topics in the middle of an example. If you're talking about a TV show, don't suddenly start discussing another show mid-paragraph. Each work and/or trope should receive its own bullet point.\
46
47	* '''Don't Write in the First Person:''' Website/TVTropes is not a forum or a blog, so using such self-referential language (even something like "This Troper") is not appropriate. You aren't the topic of conversation; this isn't the time or place to make the discussion about you.\
48
49	* '''Write in Historical Present Tense:''' Descriptions of events in an example should usually be written in present tense. Past and future tense are used to describe actions that occurred before or after the main action in the sentence.
50	** ''Right:'' Alice eats the burger Bob prepared a while back.
51	** ''Wrong:'' Alice ate the burger Bob prepared a while back.\
52
53	[[/folder]]
54
55	[[folder:Fundamentals of Formatting]]
56
57	* '''Check Your Formatting:''' Check your entry after writing to make sure it's formatted the way you intended. Double check trope links to make sure they aren't [[Administrivia/RedLink broken links]]. Try to avoid spending three editing sessions fixing your mistakes; use the Preview function to double-check your work before committing to it.\
58
59	* '''Italicize "Long" Work Names:''' Most works, such as books, TV series, and music albums, are considered "long works", and their names should be italicized. Shorter works (or parts of works) like individual songs, TV show episodes, short stories, short poems, essays or chapters should be set in quotation marks. When in doubt, it is best to use italics.\
60
61	* '''Don't Overuse Emphasis Markup:''' '''Boldface''', ''italics'', and ALLCAPS for emphasis are best used sparingly when writing examples:
62	** If you put too much of an example in emphasis markup, ultimately nothing will stand out.
63	** If you do emphasise something, just use one form of markup.
64	** The names of tropes on work pages and their subpages never go in emphasis markup for any reason.\
65
66	* '''Do Not Alter or Pothole the Trope Name:''' When adding a trope to a work page, always use the trope's correct, unaltered title -- don't use "Red Right Paw" as a pothole to RedRightHand when writing about a FunnyAnimal. Potholing the trope name isn't as clever as you may think, and it creates problems with alphabetization and wick migration. However, it's OK to use gendered redirects to tropes on character pages (but not other pages) if the redirect doesn't significantly disrupt with alphabetization, and redirects for alternate spellings (particularly Administrivia/AmericanAndCommonwealthSpellings) are acceptable everywhere.\
67
68	* '''Do Not Use Comment Tags to Pre-hide Examples:''' While existing examples that violate a rule -- particularly Administrivia/ZeroContextExamples -- may be hidden with comment tags to encourage users to fix them, ''never'' add a new example that is already commented out. It's considered lazy, sneaky, and underhanded, and repeated offenses lead to quick suspensions.\
69
70	* '''Use {{Pothole}}s to Clarify, Inform, or Hide Spoilers:'''
71	** A good use of potholes -- that is, "hidden" links within trope descriptions -- is to clarify or provide extra information to people who haven't seen the work in question. For example, potholes can provide character information: "[[FemmeFatale Alice]] kills [[TheFool Bob]]."
72	** Additionally, using a pothole in place of a name can be used to hide spoiler content: "FemmeFatale Alice kills TheFool of the work."\
73
74	* '''Avoid Irrelevant {{Pothole}}s:''' Potholes should lead somewhere relevant to the discussion at hand. Otherwise, you're just creating a distraction and annoyance for the reader. No one but you thinks your little ''non sequitur'' of a link is clever. We have come to refer to this kind of potholes as Administrivia/{{Sinkhole}}s.\
75
76	[[/folder]]
77
78	[[folder:Sorting It All Out]]
79
80	* '''Follow the Sorting Pattern Used On The Page:'''
81	** Most pages on the wiki are sorted by Administrivia/MediaCategories. Add examples to the proper medium, and if the list is in alphabetical order, follow suit. If it's not alphabetized, add your example to the end of the list.
82	** If the page is sorted some other way, follow the established sorting pattern.
83	** If the page is ''not'' sorted and has gotten long enough to ''need'' sorting, then sort them according to the method used by other pages of the same [[Administrivia/WhatPageTypesMean page type]].\
84
85	* '''Group Examples on Trope Articles:''' If there are already examples for a particular work in a trope article, you should add your example in the same section, using [[Administrivia/ExampleIndentationInTropeLists the appropriate indentation]]. If the work is belongs under a different ''medium'' from the other examples, however, list it under the appropriate medium first.\
86
87	* '''Do Not Group {{Subtrope}}s Under a {{Supertrope}} Entry:''' Always list each individual trope example separately in its proper order. There's a section in Administrivia/ExampleIndentationInTropeLists addressing this matter.\
88
89	* '''Do Not Place Multiple Tropes on the Same Bullet:'''
90	** Every trope on a page should have its own bullet. Putting multiple tropes on one bullet creates all kinds of messes with duplicate entries, organization errors, and confusion over which trope applies to which example.
91	** The most common (and most insidious) version of this is called "tropeslashing," which looks like this:
92	*** DontDoThis[=/=]ThisIsABadIdea:\
93
94	[[/folder]]
95
96
97	[[folder:Cutting the Crap]]
98
99	* '''Cut Out the Cruft:''' Administrivia/WordCruft is the term for text that serves no real purpose but to make the example longer and harder for the reader to parse. Reread your examples before posting, and cut out text that doesn't enhance reader understanding, add humor or charm, or make a point.\
100
101	* '''Purge PurpleProse:''' "Purple prose" describes writing that is ridiculously dramatic, overly detailed, and places an emphasis over being "pretty" than being easily understood.
102	** Don't use ten words where two words will suffice. You aren't being paid by the word... or at all, really.
103	** Spare us the melodramatic or flowery tone. We're talking about storytelling devices, not the eternal destiny of star-crossed lovers or whatever.
104	** If they aren't necessary -- and they almost never are -- leave the obscure ten-dollar words at home. ''Especially'' if you don't know what they actually mean or how to properly use them. Just because a thesaurus says two words are synonyms doesn't mean they're interchangeable.\
105
106	* '''Avoid Detail Bloat:''' One of the most common mistakes tropers make is believing that they have to include ''every'' semi-relevant detail in their examples, thus bloating fairly simple entries into a massive WallOfText. Examples should only include details necessary to understanding the example; comprehensive detail is neither necessary nor desirable in trope examples. This is admittedly one of the more difficult habits to break, and developing a sense of what's truly necessary can take time, but help is available if you need it.\
107
108	* '''Don't Comment on the State of the Article:''' Are you surprised that a specific example hasn't been added to the page yet? Then feel free to add it... but don't talk about how you're ''shocked'' that it's not already on the page. Commenting on the current state of a page is silly, doesn't help anyone, and such of-the-moment remarks tend to become obsolete very quickly.\
109
110	* '''Don't Comment on a Work's Popularity (or Lack Thereof):''' On TV Tropes, Administrivia/ThereIsNoSuchThingAsNotability. We ''don't care'' if a work is popular or not. Outside of YMMV tropes specifically about how a work was received, statements that a work is "famous" or "little-known" or "surprisingly obscure" are completely irrelevant.\
111
112	* '''Avoid Administrivia/ComplainingAboutShowsYouDontLike:''' The main wiki is not the place for you to complain about works that bother you. So ''don't''. TV Tropes is not a collection of {{caustic critic}}s; people are here to learn about tropes and have fun, not read about why some goofball on the Internet hated a TV show or book.\
113
114	* '''Avoid SugarWiki/GushingAboutShowsYouLike:''' We reiterate: the main wiki is not the place for you to air out your personal opinions, even if they are positive. Additionally, overly gushy writing tends to include claims that are [[FanMyopia very complimentary but not actually true]].\
115
116	[[/folder]]
117
118
119	[[folder:Editing Existing Examples]]
120
121	* '''Don't Be Afraid to Edit:''' Sometimes a prior example is worded strangely or glosses over distinct examples in its own right. You are encouraged to clean up what came before: parse down a WallOfText into bullet points, fix grammar and formatting, and eliminate natter. The cleaner the page looks, the better your example can be read and understood.\
122
123	* '''Administrivia/RepairDontRespond:''' If you think an example is inaccurate, just ''correct it yourself''. This isn't a blog or forum; do not ''respond'' to any entry. The person who originally typed the example ''does not'' hold a copyright to it; you ''can'' change it.\
124
125	* '''Administrivia/EditReasonsAndWhyYouShouldUseThem:''' When you make an edit to a page, it is helpful to fill in the "Edit Reason" box with a brief but courteous explanation of what you have added, changed, or removed along with your rationale. This helps other tropers quickly see what has changed and understand why. This is especially true when deleting examples from a page.\
126
127	[[/folder]]
128
129
130	!What Makes a Good Example?
131
132	[[folder:Good Examples Are...]]
133
134	* '''Good Examples Are Business Casual:''' In this case, the term "business casual" means that you can have some fun and don't have to write in a cold, sterile, overly academic style. In the end, though, TV Tropes is not a lawless free-for-all. You do have to take care of business -- being clear and informative -- while having your fun.\
135
136	* '''Good Examples Are Easily Explained:''' All examples must provide context, or ''briefly explain'' what the trope is and how the work uses it. However, providing context is not the same thing as trying to justify why you think the example fits the trope. The truth is, if you have to spend ''significant'' time qualifying and justifying how your example fits, it's probably not a very good example... or an example at all.\
137
138	* '''Good Examples Are Timeless:''' As a few other guidelines point out, examples should be understandable regardless of when they're read. Before posting, be sure to ask yourself the following questions, and adjust your writing accordingly.
139	** Will this make sense five years from now?
140	** Will this come across as quaint or silly?
141	** Might I be embarrassed by this in five years?\
142
143	* '''Good Examples Are Self-Contained:''' The goal of an example is to provide all of the immediately pertinent information in a fairly short, easily consumed paragraph. While it's certainly okay to refer to other pages for additional information, readers should never be required to visit other pages to have the faintest idea what you're talking about.
144
145	[[/folder]]
146
147
148	[[folder:Good Examples Are Not...]]
149
150	* '''[[Administrivia/ExamplesAreNotArguable Good Examples Are Not Arguable]]:''' Tropes are objective, so a trope either exists within a work or it doesn't. There is no such thing as an "arguable" example of a trope, so don't list any. If you think your example really is an example, add it without using Administrivia/WordCruft like "arguably", "possibly", or "could be considered". If it's not an example, then don't. YMMV entries are subjective, so there's no need to use phrases like "arguably" or "to some," because that part is already understood.\
151
152	* '''Good Examples Are Not General:''' While you don't necessarily have to cite the exact chapter or episode, examples do have to point to at least one specific instance of a trope occurring within a work to be considered valid. Broad statements and generalizations, like "Early anime dubs often had pointless cursing added to the script" may or may not be ''true'', but without at least one specific example, they're considered unsubstantiated claims.\
153
154	* '''[[Administrivia/ExamplesAreNotRecent Good Examples Are Not "Recent"]]:''' Avoid using words like "recent" or "new" when writing on Website/TVTropes. The work in question may be new when you ''write'' the example, but people might still be reading it years from now, when the work may no longer be considered "recent". Also, works tend to come out on different dates in different countries, so what is "new" to America may not be so recent in Japan or Europe. If the time of release is important to your point, use an actual date.\
155
156	* '''[[Administrivia/TypeLabelsAreNotExamples Good Examples Are Not Type Labels]]:''' You may encounter a trope that refers to different variations of the trope as "Type 1" or "Type A". Such type labels are an artifact of TV Tropes' early days, and are no longer used as letters and numbers do nothing to describe the trope or its subtype. Moreover, listing a type label in an "example" in lieu of actually providing context is considered a Administrivia/ZeroContextExample, which will be deleted and could result in a suspension if done habitually.\
157
158	* '''[[Administrivia/WeblinksAreNotExamples Good Examples Are Not Weblinks]]:''' Links to other websites, such as a Platform/YouTube video or an offsite image, are ''never'' considered sufficient context for examples. Since the Internet is constantly changing, whatever links you put in an example may no longer exist in a few weeks, or may get put behind paywalls or other restrictions, preventing readers from being able to understand your examples at all. Weblinks may be used to supplement your written example, but they are never a substitute for it.\
159
160	[[/folder]]
161
162
163	!Example Dos and Don'ts:
164
165	[[folder:Example Dos]]
166
167	* '''Check For Duplicates:''' Before you hit the edit button, it's always wise to search existing examples to make sure yours hasn't already been added. If you don't want to read them all, Ctrl+F (Command+F if you're a Mac user) the page instead.\
168
169	* '''Make Sure it's Allowed:''' Not every trope allows examples, and some only allow certain ''kinds''. Some tropes are [[Administrivia/InUniverseExamplesOnly strictly in-universe]], and others forbid [[Administrivia/NoRealLifeExamplesPlease non-fictional examples]]. Likewise, certain types of works (such as [[Administrivia/TheContentPolicy pornography]]) are not allowed on the wiki at all. Be sure to fully read the description to make sure your example actually applies, and that it's allowed on the page.\
170
171	* '''Make Sure It's Relevant:''' Be careful to avoid [[Administrivia/SquarePegRoundTrope shoehorning examples in where they don't fit]].
172	** ''Always'' read the trope description before you add an example to its page.
173	** Write the example to address the ''trope''. For example, the trope BadassLongcoat is about ''the garment'', not the person wearing it.
174	** Be specific. If a trope applies only to one specific character, it's best to list the trope under that individual character's entry on the work's Characters page if possible.\
175
176	* '''Make Sure It's Accurate:''' At times there can be many different tropes that describe very similar events. Check into those other tropes before adding examples to the wrong trope. We have the CanonicalListOfSubtleTropeDistinctions just for that purpose.\
177
178	* '''Make Sure It's Specific:''' There are some tropes that are nearly universal with a medium, such as ExecutiveMeddling with TV shows and movies. But saying "An interview with person X reveals that there was a lot of ExecutiveMeddling going on" and [[Administrivia/ZeroContextExample not explaining it is ultimately an empty example]]. We want to know ''what'' was screwed around with and even the ''why'', even if it doesn't make sense.\
179
180	* '''Minimize Spoilers:'''
181	** Remember our [[Administrivia/HandlingSpoilers Spoiler Policy]]. It is generally better to have a somewhat vague example that anyone can read than a precise and specific example covered with pieces of spoiler text.
182	** Try to avoid including plot-sensitive information like someone [[DeathTropes dying]] or [[BetrayalTropes switching sides]], unless that's specifically what the trope is ''about''.
183	** If an example needs to be ''entirely'' spoiler-tagged (including the work/trope name) to avoid spoiling the work, reconsider adding it; it won't do any good as an example for anyone who doesn't want to be spoiled for that work.\
184
185	* '''Give Sources for Anything WordOfGod Related:''' While we don't require strict Wikipedia-style citations, one ''should'' say where a WordOfGod statement originated from. Something as simple as providing a link, or giving a specific place to find the claim is sufficient. We require this because a lot of people like to [[GodNeverSaidThat claim a "fact" is Word of God]] to make their claims seem more valid.\
186
187	* '''Source Any Examples from Upcoming Works:'''
188	** Tropers can write about upcoming works on TV Tropes, but that has its own set of [[Administrivia/CreatingAWorkPageForAnUnreleasedWork special rules and regulations]] that must be followed.
189	** Trailers and other promotional materials can be troped, but the example must clearly state that it comes from promotional material and not the finished work.
190	** Don't ''ever'' trope information obtained from a leak. This is not allowed under any circumstances.
191	** Likewise, don't ''ever'' assume or make an "educated guess" facts about upcoming works. That's nothing more than making stuff up.\
192
193	* '''Remember that Administrivia/TropesAreTools:''' Tropes are storytelling devices. You may not care for a specific trope, but tropes are neither inherently good nor bad. A show's quality is not determined by the specific tropes it uses, but in ''how'' and ''how well'' it uses them.\
194
195	[[/folder]]
196
197	[[folder:Example Don'ts]]
198
199	* '''Don't Refer to Other Items on the Page:''' TV Tropes is a wiki, and wikis change constantly. So don't have an example specifically refer to information elsewhere on the page. Also, be very careful about starting an example with "Similarly," or "Like in the example above," if it isn't part of the same entry, as info may get deleted or moved. Avoid mentioning that an example provides the page image or quote, since that should be obvious to anyone who sees the top of the page, and relying on these things for context might cause issues if they're changed.\
200
201	* '''Don't Write Reviews on the Trope Page:''' TV Tropes defines "tropes" as [[Administrivia/TropesAreTools tools for storytelling]]. As such, they cannot improve or destroy the quality of a work; they merely ''exist'' in a work. Using the trope page to highlight your opinion of how the trope is used is off-topic. If you ''must'' write reviews, we have a [[https://tvtropes.org/pmwiki/review_activity.php Reviews Section]], as well as the relevant sections of the [[SugarWiki/SweetExists Sugar Wiki]] and [[DarthWiki/ThisExists Darth Wiki]].\
202
203	* '''Don't Start Crusading or Administrivia/RightingGreatWrongs:'''
204	** Always Remember the Administrivia/RuleOfCautiousEditingJudgement. The TV Tropes wiki is ''not'' the place to be pushy about your personal or political beliefs.
205	** If you decide to delete something that somebody else wrote, politely provide an edit reason explaining why. And it better be a valid, rules-based reason.
206	** Violating this rule tends to result in severe penalties, as nobody here is interested in cleaning up after whatever fights or Administrivia/{{Edit War}}s your actions may start.\
207
208	* '''[[Administrivia/SpeculativeTroping Don't Speculate or Predict:]]''' If a trope hasn't ''actually'' appeared in a work, it's not an example -- no matter how much you think it will appear. TV Tropes doesn't deal in predictions or uncertainties.\
209
210	* '''Don't Use Weasel Tropes:''' It's true that Administrivia/TropesAreFlexible, and some tropes have broad definitions. Still, it's not acceptable to wedge in examples that don't fit, especially if doing so to subvert the rules. For example, FridgeLogic is defined as "You didn't notice this until long afterwards," but some use it solely to complain about minor details that annoyed them.\
211
212	* '''Don't Use Uncertain Language:''' Phrases like "Possibly subverted in..." or "<Show X> might qualify" make the example look wishy-washy and add no informational content. If you want to add an example and you're not 100% sure about the details, then ''ask other tropers''. Surely at least one will know what you're talking about.\
213
214	* '''Don't apply tropes of a derivative work to the parent work''': Tropes should be present in the work itself, so do not list examples regarding other works as examples for the work. If the work is itself a GameMod, FanRemake, LetsPlay, etc., put it in the description. The exception to this is if a work and an official adaptation or another version of it deliberately share a page, such as our many Anime pages that redirect to their source Manga.
215
216	[[/folder]]
217
218
219	!The Final Rule:
220
221	* '''Have Fun!:''' These rules are here to help produce a useful, easy-to-read, fun environment for reader and editor alike. They are ''not'' a massive SwordOfDamocles waiting to fall on you at the slightest misstep. ''Follow'' them to the best of your ability, but don't let them ''stress you out''. TV Tropes is generally a pretty relaxed place, and as long as you aren't deliberately causing trouble, vandalizing the wiki, or outright refusing to listen or communicate, our moderator team and community are more than willing to work with you.\
222

Context Administrivia / HowToWriteAnExample