You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

projectdoc Toolbox

The model defines the context through which readers acquire skills. The level sets the expectation on the author's techniques to teach.

ID
experience-level
Set
Documentation Type
Categories
Tags
Target Types

Description

The document defines and explains the experience level required on part of the reader to get the most out of a document. The level allows the reader to judge, if the document will contain information that is comprehensible at her level of experience.

Properties

The document type provides only standard properties.

Sections

The document type adds only one section apart from the standard sections any document type provides: Topics.

Topics

The document for a given experience level is automatically listed in this document.

This listing is limited to 500 documents per level, which is enough for small to medium sized projects. If you have more topics to display, add multiple queries that fetch these documents by additional criteria. These sections will make it easier for readers to find the information they are looking for.

Details

The document is usually referenced from instances of the Topic doctype.

Related Doctypes

Here is a list of related doctypes that define types for categorization of document instances:

NameShort DescriptionSetTarget Types
Association Type
Categorize associations by a type.
CoreAssociation
Category Type
Categorize categories by a type.
CoreCategory
Charter Type
Categorize charters by a type.
CoreCharter
Excerpt Type
Categorize excerpts by a type.
CoreExcerpt
Experience Level
Defines the context through which readers acquire skills. The level sets the expectation on the author's techniques to teach.
CoreTopic
Experience Level Type
Categorize experience levels by a type.
CoreExperience Level
FAQ Type
Categorize FAQs by a type.
CoreFAQ
Generic Type
Categorize generic documents by a type.
CoreGeneric
Glossary Item Type
Categorize glossary items by a type.
CoreGlossary Item
Media Type
Resources are identified by their media type. This may be the MIME type, but also a human readable string, that identifies the syntactic format.
CoreResource
Media Type Type
Categorize media types by their type.
CoreMedia Type
Core
Module Type
Categorization of document modules for single sourcing.
CoreModule
Organization Type
Categorize organizations by a type.
CoreOrganization
Person Type
Categorize persons by a type.
CorePerson
Profile Type
Categorize profiles by a type.
CoreProfile
Quote Type
Categorize quotes by a type.
CoreQuote
Relation
Organizes glossary items.
CoreGlossary Item
Relation Type
Categorize relations by a type.
CoreRelation
Resource Type
Resources are identified by their type. This is not the MIME type, but human readable string, that identifies the semantic, rather than the syntactic format.
CoreResource
Role Type
Categorize roles by a type.
CoreRole
Section Type
Categorize sections by a type.
CoreSection
Space Index Type
Categorize space indexes by a type.
CoreSpace Index
Stakeholder Type
Categorize stakeholders by a type.
CoreStakeholder
Step Type
Categorize steps by a type.
CoreStep
Subject Type
Categorize subjects by a type.
CoreSubject
Tag Type
Categorize tags by a type.
CoreTag
Topic Type
A topic type is a semantic type of the topic. It helps to set the expectations of potential readers.
CoreTopic
Version Type
Categorize versions by a type.
CoreVersion

References

  • Wikipedia - briefly states the stages of skill acquisition by Stuart and Hubert Dreyfus, Michael Eraut and Patricia Benner.
  • Benner's Stages of Clinical Competence (PDF).
  • Pragmatic Thinking and Learning: Refactor Your Wetware - Andy Hunt.
  • A five-stage Model of the mental Activities involved in directed Skill Acquisition (PDF) - Stuart and Hubert Dreyfus

Resources

  • No labels