Differences

This shows you the differences between two versions of the page.

--- info:manual [2024/09/30 09:43] – removed - external edit (Unknown date) 127.0.0.1
+++ info:manual [2024/11/11 09:27] (current) – put formatting stuff in a new page to keep this one simpler pirkola
@@ Line 1: / Line 1: @@
+====== Editing the Manual ======
+To make changes, you will need to log in (in the upper right corner of the page) using your office network credentials.
+===== What should go in the manual =====
+Each section has some guidelines for what sorts of information should be added.
+==== Task Pages ====
+Task pages should be short and to the point.  These pages are intended to be concise summaries of how to perform a task that someone has already been trained on, but with some helpful reminders and links to the important relevant documents.  Task pages are not the place for explanations or new information, just a guide for someone who mostly knows what they're doing trying to get a task done.
+Each page should be for a single task that an operator might need to do.
+If there are any guides or DCC docs related to the task, include them in a **Links** section at the end.  Avoid duplicating information from linked documents, unless the document is hard to read.
+==== Info Pages ====
+The Info Pages section is there for all that extra information that doesn't have another good place.  It's where you go when you're looking for an explanation of how things work, and why.  If you find yourself writing paragraphs of information, it should probably go in an info page.
+The hardest part of making an info page is effectively organizing the link to it on the main Info page.  The main page is currently small, but as it grows it will need structure to keep things findable, and not just an endless list of links.
+----
+===== Page structure =====
+Each page should start with a level 1 headline containing the page title.  This title will be displayed in the user's trace, and also as the default text for links to that page.  Section titles should use headline levels 2-5, and a table of contents will be automatically displayed for headline levels 2-4.
+For any page containing links to other documents, include a **Links** section at the end with a list of all such links.
+----
+===== How formatting works ======
+The [[wiki:syntax]] page is linked at the top whenever you are editing a page, and has most formatting information.    Details specific to this wiki are in [[manual_more]].
+----
+===== Adding new pages =====
+To create a new page, make a link on an existing page, and click on it.