1.0 Title
2.0 Purpose: This wiki has been designed as a substitute for a km6 SIG for non-HRI applications.
3.0 Usage: wiki's are very open ended, essentially undefined and unstructured entities which often tend to be file dumps for information people don't know what to do with. They tend to become a mess very quickly and of limited usefulness for accurate and fast retrieval of information.
4.0 Frequency
5.0 References
[5.1] 10 Tips for Good Web Writing
[5.2] http://www.useit.com/papers/webwriting/
6.0 Responsibility
7.0 Ownership
8.0 Effort
9.0 Risks
10.0 Contents
10.0 Banner page: <wiki subject>
- this is the "elevator pitch" for the <wiki subject> for which the wiki has been setup.
10.1 Purpose
- What is the intent of the <wiki subject> wiki? What information should be kept here? What should not be kept here?
10.2 Project Information
- what project is paying for this wiki and where does the wiki fit in?
10.3 News & Events
- Important Announcements
- Related <wiki subject> events - conferences, seminars, workshops, etc.
- RSS feed <if available>
10.4 Topics
This is a continuously developing knowledge base of <wiki subject> topics which will grow and re-arrange as required. It is intended to provide a method of capturing existing or new knowledge by the <wiki subject> community - and of rearranging it on fly to a canonical form if there were one. It is not the intent that wiki copy every possible knowledge element to itself - only that a search of the wiki locate links to those resources if they are available online.
10.5 Resources:
This section is for the identification and connections of <wiki subject> related
10.5.1 Human Resources
10.5.1.1 Available Expertise:
This section is for the CV's and contact information for important individual experts in <wiki subject> It should include the primary wiki contributors as well.
eg:
Biman Das, B.Sc.Eng., M.Sc., Ph.D., F.I.E.E., C.Eng., P.Eng.
Position: Professor Emeritus, Research Professor
Telephone: (902) 494-3296
Location: MA205
E-mail: biman.das@dal.ca
B.Sc. (Mech.Eng.)- Banaras Hindu University, 1956
M.Sc. (Ind.Eng.) - North Carolina State University, 1962
Ph.D. (Ind.Eng.) - North Carolina State University, 1979
Dr. Das has been performing research since 1976 in the areas of industrial work systems design, industrial workstation and workspace design, application of production standards and feedback concepts, cumulative trauma resulting from repetitive tasks, safety in manual materials handling, and computer simulation of assembly line balancing.
10.5.1.2 Job Descriptions
This section is to describe common positions required for typical <wiki subject> projects and firms.
eg: Q/A Analyst
Core key responsibilities include:
. Intimate knowledge of Software Development Life Cycle.
. Expert in QA processes and methodology, specifically in Agile.
. Strong in Time Analysis and impact analysis.
. Experience with creation and execution of test plans test cases.
. Excellent data analysis and problem-solving skills are a must.
. Experience with various test tools: Functional, Performance, Automated.
. Commitment to the QA disciplines, processes and work.
. Must have experience working with MySQL and MSSQL database.
Minimum of 3 - 5 years of experience, good organizational and communication skills and proven success in web and application testing environment. A QA background would be an asset, but technical ability is foremost for this position.
Skills:
Mysql (Must Have)
web and application testing (Must Have)
test plans (Must Have)
test tools: Functional, Performance, Automated (Must Have)
Manual testing (Must Have)
SDLC Knowledge (Must Have)
Agile Methodologies (Nice to Have)
bugzilla (Nice to Have)
MS SQL Server (Nice to Have)
10.5.2 Organizational Resources
Organizations (not vendors - see 10.8) which have significant contribution in the <wiki subject> domain should be listed in this section with an abstract for the relevant sections that apply.
eg: W. Edwards Deming Institute http://deming.org/
10.5.3 Information Resources
The standard categories for information resources are traditionally biased to print media, but have been expanded somewhat. Web based resources should be linked at the point where they exist in the wiki (eg: Vendor websites in Vendors, Standards in Standards etc.)
- Literature Searches: Topical searches can be linked/stored form this section. (Do not store unlicensed material on this wiki.)
- Bibliographies: Zotero or similarly generated bibliographies that are not part of a formal literature search can be stored/linked at this location. While automated formats such as BibTex, COinS, MODS, RIS have their place - they can be very hard to read and may have to posted in human readable and machine readable formats.
10.5.4 Software: Open source or even important proprietary software packages should be described and linked to its source here.
eg: Supply Chain Management Software (SCM) (290 companies)
Supply chain management software (SCM) is used to track and monitor products and services.
10.6 Vendors
This section is used as a repository for important vendor information and links which pertain directly to <wiki subject> and where it is recognized that in dealing with these contacts you are first of all dealing with salespeople - not unbiased experts.
eg: Rockwell Automation - FactoryTalk View
http://discoverrockwellautomation.com/IS_EN_FactoryTalk_Suite.aspx
10.7 Tutorials:
There may be webcasts, Slideshare presentations, online courses, college courses and so-on that are available from various sources where aspects of <wiki subject> can be learned. However - books should be listed in the "Information Resources" and conferences and seminars should be listed as "events". Also, individual data dictionary elements may have more specific tutorials that should be referenced within that element.
eg: Industrial Engineering IIT Roorkee
http://nptel.iitm.ac.in/courses/Webcourse-contents/IIT-ROORKEE/INDUSTRIAL-ENGINERRING/index.htm
10.8 Standards
This section is reserved for the identification of of formal standards and "defacto" standards in the l <wiki subject> domain which form the basis for many of the project artifacts and deliverables which are created by persons expert in the domain. There is a distinction made between "official" standards - such as created by ISO and ANSI and well known documents which are created in many projects as part of the engineering or business process. (for example: there is no there is no official standard for a "General Arrangement Drawing" - but "everybody knows" what it is - maybe.)
10.8.1 Industry Standards
Any important <wiki subject> standards can be listed in this section.
10.8.2 Contract Deliverable Item Descriptions
Commonly used <wiki subject> project artifacts created as part of a engineering or business contract can be listed in this section. They should also be defined in a matter which assumes they are the "full meal deal", so the end user can omit items that are not cost effective - rather than the skimpy version where the end user may not be aware of the extended features.
Each deliverable should define:
Title - the normally used title (eg: "General Arrangement")
Purpose - what is the reason for this document or object being created. (eg: why do people want "General Arrangement" drawings? - good question)
Usage - where and when is this object useful and when should it be created? (note the "effort" item below)
Contents - what does this document or object contain? Is it just information or are there physical objects as well? What does it look like? Are there examples?
Procedures - are there detailed procedures to follow? Is there any software that can be used to create the document/object?
Frequency - How often does this document get created or revised? Is it a "one off" or something that gets revised every week or so? (like a Project Plan)
References - What are the best sources for additional information on this type of document. (i.e. where did you steal the idea from?)
Responsibility - Who is legally responsible (for engineering and accounting documents) for the quality and timeliness of the document.
Ownership - who owns the completed document? the engineering firm? the client? the government?
Effort - How much effort does a full blown version of this document take - in other words - what will it cost? (Holy Cow! - how about the "lite" version?)
Risks - What happens if we just skip this document? who's going to notice or care? what could go wrong? - What happens if we do it wrong? Do people die, or just go broke?
10.8.3 Data Dictionary
This is an extended Glossary that defines the terms used in <wiki subject> technology and business. This is used primarily for numerical data values - but may be extended to fuzzy or text values as well. If a Wikipedia entry exists AND if it is unambiguous then only the basics are required - otherwise the following elements should be defined:
- Discipline: Examples: ACCounting, Industrial Engineering, Mechanical Engineering, etc.
- KeyCode: This would be the name used in software code or as a named variable in a spreadsheet
example: SG
- Label: This is the normal title used in a formal report.
example: Specific Gravity
- Symbol: The normally used Greek or algabric format used in hand calculations should be identified.
example: ρ (rho)
- Units: The normal Imperial and SI units should be indicated.
example: lbs/ft^3 kg/m^3 (is not SG - is SW - specific weight)
- Range: The minimum, typical and maximum values for the data. A distribution curve may also apply and should be identified if known.
example: 0 - 1 - 20 (previous units assumed)
- Abstract: This is a short definition of the keycode is and how it is used; and how it was derived if known. It should include the algebraic symbolic form for the equation if possible. (Please do not use source code format unless there is good reason to do so.)
- Related Keycodes: Keycodes which are prerequisites or co-requisites for this item should be identified.
eg: ME:SW, ME:SV
- References: The sources for the derivation and abstract should be linked, stated here.
eg: [1] http://en.wikipedia.org/wiki/Specific_gravity
- Editor: The person who is responsible for the accuracy and quality of the entry should be identified.
- Procedure: If there is a formal procedure or software available for calculating this element it should be identified here.
- Tutorial: If there is a tutorial available is should be linked here.
eg: http://www.khanacademy.org/video/mass-and-weight-clarification?playlist=Physics
10.9 Projects (wiki related only)
There may be a number of special projects that relate to the <wiki subject> wiki - such as creating a bibliography or a secondary website that exist as the future "wishlist" for the wiki membership.
eg: - <wiki subject> wiki quality control
- <wiki subject> wiki development
11.0 MetaData
12.0 File Handling Policy
13.0 Procedures
14.0 Tutorials