Child pages
  • How to create your Information Model

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Document Properties Marker
overridefalse


Short DescriptionA short introduction on how to create an information model for you documentation / communication requirements.
Doctypegenerichide
NameHowto How to create an your Information Model
Short Name
Parent
Parent Property
property-nameName
hide
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
empty-as-nonetrue

Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
propertyCategories

Tags
Tag List
propertyTags
hide
Iteration

Iteration
valuefilledfinished

hide
Sort Keyhide



Section
show-titlefalse
titleDescription

Communication is hard. Writing and maintaining documentation in a wiki that is maintainable and adheres to each stakeholder's requirements is nothing to be done on ad-hoc basis. Some work needs to be invested to get started. And then expect to work in your information model on a daily basis. This is not that you failed in putting enough thought into your requirements and how you want to solve them, but because your information or communication model will change over time. Moreover you continuously learn more details about your domain that puts you into a position to improve your way of communication.

There are plenty resources out there that will support you in creating your communication model. One of them is

Cite
documentADOC:Morville2006
(which we highly recommend reading!). You may also start by reading our blog posts

If this is more than you are able to invest right now, maybe the following short process may get you started to design your set of doctypes / blueprints for the projectdoc Toolbox PDAC1.


false
Section
show-title
titleSimplified Process

This is the basic course of tasks that would lead you to your simple information model to create your set of doctypes / blueprints.

  1. Identify entities of your domain
  2. list document properties for each entity
  3. list document sections for each entity
  4. Draw these entities as circles with
their
  1. its name
in them
  1. inside
  2. Connect entities by lines and provide the navigation direction (
oneway
  1. one-way – no dynamic values!) and a name

The model you have created will help you to provide the specification for your doctype add-on.


Content Marker


Example Box
titleSimple Example with Course, Room, and Attendee
  1. Identify entities of your domain
    1. Course
    2. Room
    3. Attendee
  2. list document properties for each entity
    1. Course: Date
    2. Attendee <none>
    3. Room: Size, Equipment
  3. list document sections for each entity
    1. Course: <none> since Description, References, and Resources are defaults
    2. Attendee: List of Courses
    3. Room
  4. Image Added
  5. Image Added
    Additional properties for Course: List of Attendees, Location



Section
titleSubordinate Generics
Display Table
doctypegeneric
render-no-hits-as-blanktrue
render-modedefinition
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name

...