User:Mcefan

From LinuxMCE
Revision as of 07:03, 1 October 2012 by Mcefan (Talk | contribs) (→‎Collection of things that need to be in the documentation)

Jump to: navigation, search
Home | Editing help | Table of contents (2)



This page contains my personal notes. I use it as a memory jogger.

Collection of things that need to be in the documentation

So far, from my reading around the forum, I gather that these need to be addressed:

  • document claims and capability of the system, provide step by step instructions
  • updates, separate current info from legacy (add version info as category)
  • completeness
  • removal of obsolete articles
  • editing for readability/simplicity
  • new users centered additions (such as Networking structure & how-to, Basic system architecture - understandable descriptions of the software, Simple step-by-step tutorials for the most basic functionalities, Present a user-friendly image)
  • technical level centered organization (basic, intermediate, advanced, expert & developer)
three (SIMPLE) "flag" fields. One for the relevant version (710, 810 etc), one for the page status (eg reviewed, approved as per your suggestion nzlneil) and one for page type (instructional, overview, hack) [1]
Draft Page Status
  • categorization, indexing/organization
  • try to generalise what we already have out there. In no particular order...
- Hardware pages eg motherboards, z-wave device
- User pages
- Overview pages eg this is an MD, this is a core, the network must be set up like this because...
- Instructional pages eg the procedure for adding a light, NOT hacks
- hacks
- source on the Task | Identify structure of wiki | reqruiting / assessing thread
  • clearly label hacks as hacks so people do not mess their systems unknowingly [2]
    Hacks will need to get a disclaimer.
  • a table of hardware compatibility connecting to corresponding linked articles
  • consistent favorites navigation (News, About, Documentation, Forum, Download, Contact Us)
  • uniformity, standardization of articles
provide detailed instructions on how to create the perfect wiki article with a link to the template everyone should use.
- In the "Administering Content" subheading, we would have a table showing who is responsible for administering each major wiki chapter. Their first job would be move existing relevant articles into their chapter of the wiki. Administrators would periodically look at their wiki chapters for new content to make sure people are following the rules. If they found a problem they could fix it on the spot, get the author to fix it, or remove the article. If a particular chapter seems incomplete, an energetic administrator could go to the forums and request articles.
  • front page redesign
We have to redo the manual / frontpage wiki, the important part about this that it needs to be maintained.
Task | Frontpage wiki | assessing
DragonK[3]
Somewhere on the front page of the wiki, we should have a link called "Wiki Tutorial - Adding and Administering Content"
  • redo the youtube video [4]
  • provide project news that affects users
  • provide entry to the Forums and the Wiki
  • appoint a dedicated documenter and one programmer to whom the documenter can ask questions
  • create and document method of communication between authors and users that have questions regarding an article
  • encourage notes taking on user page?
To create a user page, register on the wiki (now requires an active forum account, I understand, & which you have). Then search for your user name, and when it says there's no page for that, chose the option to create one.[5]

Proposed Color Scheme

  • Text: #000000
  • Highlight: #123456



Ongoing

Forum thread, latest post




To complete:

  • Contacts
  • read pages with :user
  • catalog working equipment from user pages
  • So, how does it work?
  • What do I need to run LinuxMCE?
  • What to buy?




My objectives

  • organize and make information manageable
  • increase accessibility and findability
  • help users find information and complete their tasks (fulfill their information needs)
  • build information structures that allow others to understand
  • make the information useful
  • improve user experience, usability, and user interface
  • provide an effective presentation and use of information
  • help people share information

Abstract the essentials from this complex body of information, and make those essentials easily accessible to a user in a clear and esthetically pleasing presentation that creates meaning or understanding.



Miscellaneous notes

http://wiki.linuxmce.org/index.php/Software_components

from twodogs on forum dicussion:
"Wiki articles should be written with beginning users in mind. Readers should be provided an overview of what they are doing before being given a laundry list of steps to perform. If the overview already has already been covered elsewhere, a link to that source would be helpful. If no overview exists, then an introductory paragraph might eliminate repeated cries for assistance in the forums."

Invited to join the effort:

Found ongoing effort on forum: [6]

Found Wikiworkgroup: can't make sense of the purpose of the page, nor the title. If you create any page, its purpose should be stated and its contents summarized at the top of the page to avoid user confusion.

Read brononius' personal documentation of linuxmce (link currently broken)



Retrieved from "http://wiki.linuxmce.org/index.php?title=User:Mcefan&oldid=32456"