Tags:
create new tag
, view all tags

CFK Documentation Initiative


Table Of Contents


Here are my thought with regards to how the documentation should be disseminated. Below are three initial pages for getting started. I feel that the assembly should contain some rough sketches, maybe sample images, but nothing too fancy; on assembling the systems. Since we have a myriad of computer types, we have to find a way to generalize into a simple document.

My opinion is that these first three topics (change this if more are added) should comprise the printed manual we give them. I don't want to get crazy on printed stuff. If we take them from turning on the machine to login, the rest can be online, html format. I foresee an icon on the desktop that says "help/ayuda."


Comments

Looks good! I have one general suggestion though, and have tried to demonstrate an alternate approach on TurningTheWorkstationOn -- I've added descriptive (I hope) headers and a (TWiki) TOC, so that, with luck, the TOC provides an overview of the necessary steps -- thus the document can serve as both an introductory manual and a quick reference -- if you know how to turn the monitor on, you don't need to read the how, just be reminded by the TOC that it is the first step. -- RandyKramer

Comments?

I like your additions. Now that we have a general concept down, I would like the wordiness removed and the page turning into more of an outline with pictures. Something like a list of steps as opposed to paragraphs of information. I hope I am conveying my idea properly. -- DannWashko

Yes, I think so. I have no good way to make pictures, or much interest in doing so -- I suggest we figure out what pictures we want and then see if there is a volunteer who would like to attempt to make them. (Also, we need to decide whether to have the pictures inline (on the page) or on separate pages (or thumbnails on the page and larger images on separate pages). We may even want it different for a printed copy vs. an online copy (and possibly even two versions, hi bandwidth (with pictures) and low bandwidth (with thumbnails or with pictures only on separate pages).

Anyway, those details can be worked out later.

But somewhere I did start a sort of specification for pictures -- I'll have to find it again -- ahh, here it is -- UsingTWikiAsCfkDocumentation (and with the suggestion to include a list of desired pictures on each page as we write -- I included that in the template and I think I have at least one page where I listed one or a few -- <looking for that page> -- well, now I've added a list to Turning the workstation on, along with some other comments.

I'll read the page again -- don't know how much wordiness we have in at this point, but do you want to take a shot at editing it down or would you like me to? (There's a chance I'll start when I go reread the page this morning.) -- I often like the idea of two versions of a page -- a ...Beginner page and a ...Reminder page (see Wikilearn.UsingFtpBeginner and Wikilearn.UsingFtpReminder -- in this case (CFK) I was attempting to make the TOC the reminder -- it might work in this case, not sure it will always work.

-- RandyKramer - 15 Mar 2003

Contributors

  • () DannWashko - 08 Jan 2003
  • DannWashko - 10 Jan 2003
  • <If you edit this page: add your name here; move this to the next line; and include your comment marker (initials), if you have created one, in parenthesis before your WikiName.>
Edit | Attach | Watch | Print version | History: r3 < r2 < r1 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r3 - 2003-03-18 - RandyKramer
 
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by PerlCopyright 1999-2017 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding WikiLearn? WebBottomBar">Send feedback
See TWiki's New Look