Edit Guide: Difference between revisions

Edit Guide (view source)

Revision as of 12:23, 23 May 2023

1,474 bytes added , 23 May 2023

no edit summary

Mvanmierlo

1,646

edits

@@ Line 7: / Line 7: @@
 ==Writing your article==
-Each howdoi page should answer a question (ex. How do I find a list of Riverdale Google Calendars). This is so that articles stayed focused on the question at hand.
+Each howdoi page should answer a question (ex. How do I find a list of Riverdale Google Calendars). This is so that articles stayed focused on the question at hand and provides only the necessary information.
-* each page starts with an <nowiki>{{abox}} and ends with a {{CategoryTemplate}}</nowiki>
-* inline images (for instructions) are now added in a very particular way, with a variation of this code:<br>
+# Each article starts with an <code><nowiki>{{abox}}</nowiki></code> template. Update the template accordingly and make sure the fields '''''cat1''''' and '''''cat2''''' are appropriately filled in.
-::<nowiki>[[File:Interesting cal.png|thumbnail]]Here's a picture of what you should do<br clear="all"></nowiki>
+# Use the '''''Heading''''' styling ( ^ 2 ) for major section titles. If a sub-section is needed, then use '''''Sub-heading 1''''' ( ^ 3 ).
-:which gives you this, including the open space before the next instruction:<br>
+# Use '''''Paragraph''''' ( ^ 0 ) mode for other text.
-::[[File:Interesting cal.png|thumbnail]]Here's a picture of what you should do<br clear="all">
+# If you refer to a menu item or UI element for the intended user to interact with, then '''''bold and italicize'''''. This is to make the article easy navigable, so that the key steps are easy to find at a first glance without getting lost in the text.
-:plus you can alter the size of the images by adding "|100px" (or another size) as follows:
+# If the user needs to type something in a textfield or text area, then "place the text in quotation marks".
+# Include images that you think are necessary, but also remember the following: the more images you include in your article, the harder it will be to update content when UI's and OS's change.
+# If you want to include images, make sure to un-check the '''''Wrap text around this item''''' box. Images, as a rule of thumb, should not exceed a width of 500 pixels unless there is a good reason to do so.
+# If you think it would be useful for the article, feel free to add a <code><nowiki>{{Category}}</nowiki></code> tag to include a list of related articles. Some common categories includes...
+#* <code><nowiki>{{RCS Software and Services}}</nowiki></code>
+#* <code><nowiki>{{Classroom Technology and Systems}}</nowiki></code>
+#* <code><nowiki>{{Veracross}}</nowiki></code>
+#* <code><nowiki>{{Chromebook}}</nowiki></code>
+#* And others!<br>
+== In-line images (if needed) ==
+::* <nowiki>[[File:Interesting cal.png|thumbnail]]Here's a picture of what you should do<br clear="all"></nowiki> which gives you this, including the open space before the next instruction:<br>
+::[[File:Interesting cal.png|thumbnail]]Here's a picture of what you should do<br clear="all"> plus you can alter the size of the images by adding "|100px" (or another size) as follows:
 ::<nowiki>[[File:Interesting cal.png|thumbnail|100px]]</nowiki>
 :to get this: