Welcome

Posted February 24, 2010 by Larry
Categories: Welcome

Welcome, do not let the title fool you. There are no means or resources to teach you how to hack SharePoint. What you will find here are tips and tricks for real life applications. I have many scripts that I have hacked, from other writers, to fit project requirements. I am hopeful I can share them with you so you can utilize the same information.

Requests
if you have a Request, please post them here.

Follow this format if you want to post readable code in comments

[sourcecode language="javascript"]
//your code
[/sourcecode]

Are you experiencing trouble with your children? Are they strong-willed or out-of-control? Remember most kids are not bad, they just make bad choices. Learn how to motivate and influence better choices. Visit theparenthelpcenter.com/.

Changed parents will see changed kids

InfoPath, Microsoft Strikes Back!

Posted January 17, 2012 by Larry
Categories: InfoPath

It’s been a while since I have posted. It has been very hectic. I am slap dab in the middle of a project and it is kicking my butt. For simplicity purposes I am developing an InfoPath (IP) form for what could be used as a billing system. Although IP could not do this alone it is much easy to develop the UI in IP then to try and replicate its functionality in .NET.

Initially I started out with one single form, but the deeper into the rabbit hole I went the less IP was compliant. My Secondary Data Sources were simple SharePoint (SP) lists. The Sr. Developer dropped some code into SP so any data entered on a list in that site would automagically be updated in a SQL Database. The reason for this was to speed up the data feeds to the IP form. By storing supporting list and the IP form as an XML blob in the db we could write Stored Procedures and pass parameters, thus allowing data filtration before it gets to the form.

Now on the eighth iteration of this form and I’m still struggling a bit with what IP will allow me to do and what needs a bigger hammer to make it work. Several releases prior I went to IP template parts (TP). I chose this path now because I have learned more about the project. Eventually I will roll out many forms which will be variations of the main one. I will be setting them up as templates with prepopulated data. The total number of needed forms is unknown at this time, but I am expecting about 32. Playing with the TPs I figured make one change, and update all, right? Wrong. Well for the most part this is fairly true. Here are some issues I ran into.

When you change or create a TP it has to be added to IP as a control. As an updated TP you have an option to update form with the new TP. This means every form has to be opened to make the update. Most of the time this will be fairly simple except under these conditions

  1. Adding a new field to the TP
  2. Resource files
  3. Button Control IDs
  4. Default values, Rules across TPs (If multiple TP exist on one form)

Let’s start with adding a new field. I did not figure this out right away. It took several modifications to understand when this issue occurred. I found after updating a form with a modified TP the UI of the form looked unchanged (except for the modifications), but when you looked at the schema (field structure) it added a replication of the original node and in addition prefixed all field, group and section nodes in the TP with a “_1″, “_2″ etc…. In the figure you will see to nodes, myLineItems and myLineItems_1.

Maybe this is not critical sometimes, but for this project we are depending on the XPATH for every field. If this changes the code on the back end will break. I struggled a bit with this trying to figure out why this happened only sometimes. So I started noting every step each time I updated the TP and began comparing differences. I found when I added a new field to the TP upon update in the form it would create a new replicated section. Now that I found the culprit I needed to find a solution to prevent this. For now it is nothing fancy. I found If I deleted the part and the field nodes from the form, saved the form and closed it, upon reopen I could add the updated TP and keep my original names for all the fields, groups and sections. I’m not sure why Microsoft would build functionality like this. If I copy a file in windows I get an alert to over write or rename. Why not build this into the TPs, giving the user the choice to over write or create with new name?

Moving on to the Resource Files and how Microsoft strikes again. In the attempt to save time when updating TPs I started adding Resource files to the TPs. This way when updated I would not have to re-add or attach them. For XML files it is not such a big deal, but images used in Picture Buttons is a nightmare. Microsoft decided to replicate these also. So a form with several TPs and several Picture Buttons could end up with 15-20 resource files once the TPs are imported into a form. I do have to give them some credit for the data connections. At least these do not replicate, but are renamed with the TP name at the end. No matter how many times it is updated it will keep that name even when you rename it in the main form. So why can’t we have a similar functionality throughout the form? Now each iteration I roll out I find myself going into the resource files and deleting the duplicates, then updating all the picture buttons and renaming the Control ID’s.

So if I create a button, picture or not, in a TP and add it to a form with a specific name, why on updated does Microsoft give it a default Control ID in the main form? If you are running code off the button click event, once it is renamed the function doesn’t fire. Now I have to go back and touch every button and rename the ID to match the form code. I know what you’re thinking; why not name it in the TP before updating. Yes, I already did this and it does not retain this name. Another major fail!

My final complaint is focused on the maintenance of default values and rules across TPs. I created a multiple select for day of the week using a repeating table. Without going into any major details I set 7 default values one for each day of the week and in the header a checkbox to select/unselect all. By default you can see the first default value. A typo on my part added “Sat” first instead of “Sun”. No matter how many time I have changed this, updated, in the TP or deleted the TP from the form it will not update in my final product. I am forced to go into the main form and make this change there. Again for the most part the rules stay intact, but when Microsoft forces me to delete the existence of the TP because it wants to rename it I lose all the rules I have had setup. Not knowing this can be frustrating when published an administrator approved template, launching the form and nothing works.

This process of elimination took many hours or pulling my hair out. Although some of this stuff may sound obvious when you’re in the fox hole we can sometimes over complicate what we are doing, putting more into it than what we really need to. I am hopeful Microsoft can fix some of these issues on the next release of IP, but I am sure that version will have its issues for us to find and deal with.

InfoPath 2010 Rules Management and the People Picker

Posted December 12, 2011 by Larry
Categories: InfoPath

I have been getting some real time on InfoPath 2010 and currently in the process of developing a code less form. Eventually code will be added for the back end functionality, but for now I will push InfoPath to its limits. I have two issues I am trying to work through. First one is the userName() function not returning a value equal to currentuser. This most likely is related to the Active Directly account, or how it was set up. One of the new features of IP 2010 is the Contact Selector already part of the arsenal. Several things I have found seem to be related to how users are setup in Active Directory (AD). After several hours of play I was able to get a working solution. Once I had a solution I tried to make it a template part so I could make it available to everyone without configuration, which was a major fail. For some reason Microsoft felt the need to limit this functionality.

Setting this up is fairly easy once you know what has to be done. This is done through the Picker field’s task pane, “Show Advanced view” for field details.

  1. Right click on AccountId
  2. Select Properties
  3. Under default value, select the function builder
  4. Type userName() in the Insert Formula window
  5. Click OK
  6. Confirm “Refresh value when formula is recalculated” is unchecked. Doing this will ensure that this rule will only run once and not every time the form is opened.
  7. Click OK
  8. This must be repeated for the DisplayName for optimum experience

Results: The People picker will result to the person who opens the form and saves it for the first time.

Feel free to contact me with aby questions

Chunking Content – Part 6

Posted June 29, 2011 by Larry
Categories: Writing

In Part 5 we reviewed the Map and how the Block plays a role in its structure. This post will review the units of information Blocks and Maps making it easier to apply Design Principles. This part will conclude the Design Phase of writing.

Block
Blocks are relevant chuncks of content with a label.

Map
Maps are a collection of Blocks with a title.

Components
Block

  • One main idea
  • A Label
  • A Separator

Map

  • No more than seven plus or minus two (7 ± 2) related Blocks
  • A title that reflects the purpose or main idea/content

Summary

In the first Five parts we explained the importance of how we write. The different between on-line writing as compared to paper or books. Outling the the changes to support a layout out the the end user finds easy to use and navigate through. The strucure of Maps and Blocks also provided scanability for the users, which allowed for them to quickly find what was needed.

As we move into the Develop Phase we will also describe the principles used and presentation. You will be able to identify the difference between Process and Procedure. Although Process and Procedure have a similar look and feel because they both deal with action the difference will be determine by the Scope and Detail of the information.

Display options from Choice Multiple Select in separate columns

Posted June 29, 2011 by Larry
Categories: JavaScript, WSS

I recently came across a request to display the options from a choice multiple select across multiple columns Like this:.
results

When I began to work on this I had a totally differnt path. My initial thoughts were to create a calculated field, and then place the values into another calc field with an HTML table. I have used tables before in a calculated field with the help od a script from pathtosharepoint.com text to HTML. This direction was impossible. Nothing I was trying would even work. I knew that I could trick sharepoint into reading a Choice field, but this turned out only to be true when it was single select.

So to get started I had to create my choice multiple select field.
“WorkType” – When this is first created it must be created as a single line of text.

“calc” – Second field is a calculated field =[WorkType]

Delete “WorkType”

Create new field
“WorkType” choice, multiple select

The “calc” field now will read the the string from “WorkType” the output will be something like this
;#Choice1;#Choice 3;#

The next set of fields depends on the number of options you have. My demo has 5 options (opt1-5) so I created 5 calculated fields

opt1 =IF(FIND(“Choice 1″,[calc]),”Choice 1″,”")

opt2 =IF(FIND(“Choice 2″,[calc]),”Choice 2″,”")

opt3 =IF(FIND(“Choice 3″,[calc]),”Choice 3″,”")

opt4 =IF(FIND(“Choice 4″,[calc]),”Choice 4″,”")

opt5 =IF(FIND(“Choice 5″,[calc]),”Choice 5″,”")

The formulas are searching the string (in [calc] for a specific value. When you setup yours Choice 1 would be your option 1, same thing for the returned value if true.

This returns the values in each column as it should , but the find formula returns #VALUE! it the formual is false like this:
results

I could not figure out a way to remove the #VALUE!. So I deciede to go with a string replace.

<script type="text/javascript">
var theTDs = document.getElementsByTagName("TD");
var i=0;
var TDContent = " ";
while (i < theTDs.length)
{
  try
  {
    TDContent = theTDs[i].innerText || theTDs[i].textContent;
    if (TDContent.indexOf("#VALUE!") == 0)
    {
      theTDs[i].innerHTML = TDContent.replace(/#VALUE!/,"").replace(/#VALUE!/g,"");
    }
  }
  catch(err){}
  i=i+1;
}
</script>

This looked very clean and the options are displayed in individual column in order.
results

Who said I dead, who said I’m gone!

Posted June 13, 2011 by Larry
Categories: InfoPath

I know it has been a while since my last post. Much has taken place. I began rebuilding a home and I have started a new job. After my first day at the job I am excited to dig further in. I have dabbled in the SharePoint platform for 7 years now. I have developed several InfoPath forms and created much customization to the SP UI and enjoy this work, but at my last p[osition this was lacking. The tasks I was getting assigned were no where near the type of challenge I need.

In my current role it almost appeared to be too good to be true. It is the kind of work I enjoy all the time. I almost feel like I get to play, and I am paid for it. After my onboarding session I was given and InfoPath form near completion. The original creator had been pulled into other priorities and not able to complete the form functionality. The issue was related to a simple dynamics. When specific conditions are meet an Approval field needs to display. On initial my thoughts of this I figured this was fairly simple, but the author explained that he had been down this path and he felt the issue had something to do with the userName() function in InfoPath returning a case difference in the account name from SharePoint People Picker. During testing within the company 2 user names were getting this issue and the field dynmamics were not working properly.

SharePoint: Wiki Bookmarks Part 3

Posted December 22, 2010 by Larry
Categories: jquery

In Part 1 I discussed some of the issues and a possible work around for the limitations a SharePoint Wiki offers. In Part 2 I resolved the bookmark issue and added tabbed content. Although the tabs are a cool functionality it really did not fit the original requirements of just fixing the bookmark functionality lost in the SharePoint Wiki.

Fixing the bookmarks was really fairly simple to resolve for with a few lines of code. The real issue was the top navigation. How can we produce a quality looking structure that I would be proud to put my name on? Again I am drawn back to the tabs. Really I only need to figure out how to prevent the content from hiding, and keep the tabs floating at the top of the navigation for ease of use.

Since I first drafted this article in July 2010 , I have worked closely with Kerri Abraham from NothingbutSharePoint formerly known as EndUserSharePoint. She was the inspiration for me to begin this work. Even though I was able to find working solutions, I still could not meet her project requirements, which boiled down to a nested navigation. Kerri never gave up. Her and her intern, Hannah Zimbeck continued to chip away until they reached their final solution. What impressed me the most about this solution is they identified an issue related to SharePoint 2010 and came up with a solution for it. I know this will save me time when I finally upgrade.

Congrats to Kerri and Hannah for a job well done. I was happy to help and assist you.

SharePoint Wiki nested navigation using bookmarks

Chunking Content – Part 5

Posted November 10, 2010 by Larry
Categories: Writing

In Part 4 we reviewed Maps and Blocks. Detailing the foundation of a Block and its structure. In this part I will review the Map and how the Block plays a role in its structure.

While Blocks have replaced the conventional paragraph, Maps provide a unit of information that is unique and precisely defined. There is no parallel unit in conventional writing. Although Maps are larger than Blocks they are smaller than sections and chapters. In unison with Blocks, Maps aid the writer with a mechanism to apply the Design Principles.

 

Why Maps?
In conventional writing paragraphs can be grouped and organized into many sizes and types of information within a document like Sections and Chapters. The problem with this is there is little to no consistency between writers, document structure and unit size. The Information Mapping methodology groups Blocks into Maps, Maps into Chapters or Sections.

 

Maps
We have discussed that a Map is a collection of Blocks. A Map should also contain a title, similar to the Block the Map should:

  • Describes one topic
  • Each Block contains one idea related to the Map title (topic)
  • Map Title and Block Labels:
    • Describe the content
    • Preview content, for reader
    • Make content easily scannable

A reader should be able to anticipate the content, main idea or point of focus of a Map by its title.

 

Map Guidelines
As we develop our Maps keep in mind the following guidelines:

  • One topic per Map
  • Remember the chunking methodology, no more than seven plus or minus two (7 ± 2) related Blocks in a Map
  • Map Titles should be unique
  • Map Titles cannot copy Block Labels
  • Map Titles and Block Labels follow:
    • Describe the content
    • Preview content, for reader
    • Make content easily scannable

 

Format
For the most part Maps have a title, followed by Blocks. The Block have a visual separation usually a space or vertical line.

  • Paper Format
    • Keep it readable, don’t crowd the paper
    • One inch margins
    • Keep page orientation throughout document
  • On-line format
    • Much more flexible so be consistent
    • Accommodate your audience
    • Labeling is much more crucial because blank spaces lose their effectiveness with on-line content

 

Alternate Formats
Layout and orientation should always take your audience into consideration first. As long as you follow this guideline there are many ways to format your Maps.

  • Block labels are clearly visible, distinct from your content and easily scannable
  • Map Titles are the most prominent headings on the page
  • Where the Map begins and end is clear
  • It is clear which Blocks belong to the Map

 

Results
Your layout should be like a road map, where you are now and where you are going. When on the road your perspective it limited to what is around you and cannot see the shortest route to your destination. Information should follow the same structure. When buried in a wall of text you cannot find your way out and finding the information you need becomes a gamble. Mapped Information allows you to grasp the subject matter and general organization of the content very quickly by using:

  • Block Labels
  • Map Titles
  • Consistent hierarchy
  • Tables
  • Overview Maps

 

Does size really matter?
The physical size of a Map is far less important that the conceptual size or the amount of information it contains. To remain compliant with chunking limits, Maps should not exceed nine Blocks, with each Block focused on a single topic. It is possible for a Map to contain one or two Blocks, but only when presenting a summary, guideline or list of rules in the context of a large document.

 

Overview Maps
In the previous Block I mentioned Overview Maps. These are a specialized Map that is added to an information unit to aid in comprehension. Aiding in organization of content for chapters or sections and sometimes transitional information. The content of an Overview map contains:

  • Map title to follow
  • Orients the reader
  • Provide transition and flow

Overview Maps are used at the beginning of:

  • a book
  • Chapter or unit
  • Section within a chapter or unit
  • sequence of related Maps

 

Conclusion
In this part we have reviewed Maps and their construction and discussed their layout, Paper vs. On-Line. Remember that it is most important to remember who your audience is when developing your Map and it is the conceptual size of your Map that is more important that its physical size. We have reviewed the four design Principles, Chunking, Relevance, Labeling and Consistency. This is the foundation for organization and structure of the content.
In Part 6 I will move into the Development Phase and its Principles, which consist of two basic items; integrated Graphis and Accessible Details.

Chunking Content – Part 4

Posted August 30, 2010 by Larry
Categories: Writing

It has been some time since I have been able to pick back up in this series. I had a project deadline that was necessary to meet. To do a quick refresh let me recap what we have already covered. In Part 1 I discussed the Challenges of creating content along with some of the benefits to chunking. In Part 2 I reviewed the most common Information Types and how they are used. In Part 3 we left off at describing the details of our content or the four Design Principles.

  • Chunking
  • Labeling
  • Relevance
  • Consistency

These pieces make up our Maps and Blocks allowing us a way to apply Design Principles in our writing.

 

What are Maps and Blocks?
They are convenient and efficient ways to utilize the Design Principles. Blocks are a relevant chunk of information that contains a label and Maps are a group of related Blocks, somewhat like a Parent Child relationship.

 

Blocks
A Block is a manageable chunk of content containing related information. A Block will contain one main idea, a descriptive label and a separator. It will include a single Information Type such as:

  • One or more sentences
  • a list
  • a table
  • graphic/image
  • media

Traditional writing consists of paragraphs, which are made up of groups of sentences, but in order for us to write efficiently paragraphs do not meet the need for quick access. So Blocks will replace the traditional paragraph because Blocks are structured and precise making them easier to read and understand.

Chunking information fits any medium. For on-line content development there is more freedom as to how the guidelines are applied. A Block separator on-line could be a link, video/audio or frames on the web page.

 

Block Labels
describe the purpose, function or content allowing the readers to easily

  • Preview
  • Scan
  • Skip
  • Find

There are three popular Label Types

  • Generic – identifies purpose or function, but does not describe the content
  • Content – describes the content
  • Combination – has both

 

Block Labels should be:

  • Brief
  • Easy to read
  • Unique – to the page
  • Consistent – with glossary or terminology
  • Visually distinct from block text (bold)
  • reflective of content, purpose and importance
  • meaningful for the reader

To write good useful Block Labels consider this:

  1. What is the Block main idea?
  2. What do I want to say about that idea?

 

Long Block Labels
Blocks that exceed the chunking limit are difficult to read. As the writer you must find ways to resize the Block to make it more manageable by reviewing and revising.

IF THEN
Block has more the one main idea Create new Block
All content doesn’t relate to the Block Label
Content is closely related Use sub-labels
No logical divide for new blocks
Text density possibly overwhelming add extra space
Block cannot be divided in any other way

On-line content offers other ways of sizing Blocks like: tool tips, popup windows and hyperlinks. This provides the reader with all the content while maintaining Block size limits and not overwhelming the reader.

 

Short Block Labels
Now that we discussed long Blocks, we have the other extreme. Can a Block be too small? As long as we remember that the content in a block must have enough information to stand alone and still communicate its purpose.

One sentence Blocks can effectively communicate an important issues such as:

  • Warnings
  • Key reference
  • Policy Statement

Too many small Blocks can hide the message by distracting focus. Again try to consolidate similar content to create fewer Blocks.

Conclusion
Today We highlighted Maps and Blocks. Comparing the relationship of Maps and Block to regular writing techniques of sentences and paragraphs, outing lining the foundation of a Block and how it is structured. In Part 5 I will details the foundation of a Map and how the Block plays a role in its structure.

Chunking Content – Part 3

Posted August 5, 2010 by Larry
Categories: Writing

In Part 2 I discussed, in detail, the Information Types. What they are and when they are used. I concluded on the Design Principles, which are guidelines for writers to structure and organize content. Today I will describe these principles.

Chunking is a manageable unit of content/data that a reader can easily process and understand

Applying this principle helps eliminate information overload for the reader by setting the size limit for a unit of information. Research suggests that we can best process and remember no more then seven plus or minus two (7 ± 2) pieces of information at one time. When we are given more than maximum recommended amount we have difficulty remembering it. Applying this technique to on-line writing makes the data more accessible and usable. Because it’s more tiring to read information on-line than on paper, it is critical that the information be chunked with clearly defined beginnings and endings.

Example:
Having to write 24 Benefits policies for on-line access one could break out the policies into chunkable sections:

  • Health and Medical
  • Time and Attendance
  • Long and Short-Term Disability

These sections could be broken down into smaller manageable chunks because on-line users read very little. It’s obvious users will spend more time on pages that contain more information. So when the on-line content is to be used as a help guide or reference material time is of the essence.

On average users read half the information on pages with about 100 words. On a page containing about 600 words users will read about 28% of the text per visit1. In a study writers were able to increase usability 124% by combining several writing techniques2.

  • Concise text – using about half the word count.
  • Scannable layout – organizing the text in a layout that facilitated scanning
  • Objective language – using neutral rather than subjective, boastful, or exaggerated language.

The wall of text or scrolling content.
In the early 1990′s users did not scroll either because they were unaware they needed to or did not know how. About 80% of the usability guidelines are still in force and although users will scroll today writers most avoid the wall of text because:

  • Run on text continues to be problematic, readers have limited attention spans. Users prefer sites that get to the point and lets them quickly move on. Besides the basic reluctance to read more words, scrolling is extra work.
  • The visible real estate is more valuable than the stuff not visible for attracting and keeping reader’s attention.

Best Practices

  • Stay true to the chunking limit (7 ± 2)
  • Only when information is familiar or understood, increase chunking limit
  • When unfamiliar, decrease limit
  • Avoid the wall of text
  • Your readers are the best tools in determining your chunking limits

 

Relevance – limit each unit of information to one purpose, topic or idea.

This principle helps readers feel the content is organized. It assist with comprehension and saves time because it’s easier for the users to

  • focus
  • learn
  • remember

Chunking and Relevance go hand in hand. Chunking deals with the quantity of information and Relevance determines the type the chunk includes.

  • Chunking – deals with quantity
  • Relevance – deals with type of information within the chunk

These are useful especially on-line because:

  • There is a limited amount of visible information at any one time
  • Previously read information disappears more quickly online leaving the reader with a limited context of visible information

When applying Relevance readers can

  • Identify critical items (priorities)
  • focus on one point at a time (Main topic)
  • quickly grasp the subject matter

Best Practices

  • All material in a chunk relates to a single idea
  • Indirect, transitional and nice to know information (content that can be skipped) in separate chunks

 

Labeling – each unit of information

Labeling helps readers get a preview of what’s to come. This helps them understand and access the information easier, by providing visual indicators or logical breaks identifying what the information is about. They stand out to the reader and allow for scanning, skipping and retrieving. Some labeling methods include vocal, written, graphic and/or symbols.

Best Practices

  • Label all information units
  • Most stand out from surrounding text
  • Accurately describe or preview the follow text.

 

Consistency – Similar terms, formats, organizations, labels, sequences and abbreviations in similar content.

When writers consistently apply this principle it enhances usability and comprehension because:

  • Predictable – readers know where to find what they want
  • Efficient – finding it more quickly.
  • Increased Learning – absorb and understand easier
  • Less Distractive – focus is on content, not form.

Some of the benefits to this Principle is that multiple writers can author the same piece of content and it be invisible to the reader. Outputs or deliverables have a common look and feel, bringing standards to the next level and building cohesive units. The readers have a greater understand of the content and the relationships and similarities between the pieces of information.

Best Practices to consider are the use of standards. Identify a standard look and feel, maybe templates and the type of material included in the templates.

Example:

One template may include content specific to a Job Aid or Tool. This kind of template is not used frequently, but provides useful information like contact names and numbers.

Another type may be process or procedure, where this contains specific step by step instructions of how and when.

An image library will aid in providing a central location for writers to select and draw from when creating content. Some typical use of visual images may include symbols for warnings, caution or help. Following industry standards helps making it easier for the reader to understand.

 

Hear in Part 3 we have reviewed four key Principles that should be used when writing content. Some details included the benefits of following these Principles while providing best practices for each. In Part 4 we will continue to dive deeper into the art of writing by discussing Maps and Blocks. These are used for writers to apply Design Principles to their content where Blocks are the “Relevant Chunks” and Maps are made up of groups of Blocks. Maps and Blocks are based on Information Types and Design Principles and as we continue we will describe the structures, why we use them and their benefits.

  1. http://www.useit.com/alertbox/percent-text-read.html
  2. http://www.useit.com/alertbox/9710a.html

Chunking Content – Part 2

Posted July 27, 2010 by Larry
Categories: Writing

In Part 1 I discussed some of the benefits of chunking content and some of the challenges we face developing a layout for content. Today I am going to describe Information Types. One of the most challenging tasks of communicating is to identify the specific content your users needs. That is, what questions are your users trying to answer as they navigate through the content? Information Types categorize key technical and business information according to the purpose of the communication, from the user’s perspective. Information types should also have specific formatting and presentation guidelines.

Information Types

Nearly all business and technical communication can be classified into six major information types or categories, which are based on the purpose of the information for the user.

  • Principal – a statement designed to guide behavior
  • Process – series of events
  • Procedure – set of steps a user needs to perform to complete task
  • Concept – a general idea to defines a class or group
  • Structure – contains parts and boundaries
  • Fact – a statement that is true

Principal
Use this type when it looks like fact, prerequisite or criteria. This allows users to understand what is required.
Example:
Do not use the chair within 24 hours of gluing.
Use only all natural wood polish for the best shine.

Process
This type shows how things work, conditions, results. The entire perspective on a situation or issue. The who, what, when, where, why and how.

Example:
To understand how it happens, not how to do it. Use for diverse audience, different needs.

Procedure
This type is used to give detailed instructions when the user needs to know how to do something or when and how to make a decision. An active language that instructs the reader similar to a step action table.

Example:

STEP ACTION
1 Start here.
Note: additional text.

IF THEN
True Do this
False Do that
2 Click Import
3 Click OK

Concept
This type is used when we have the need to define a new term/idea. When we need to describe why or what something is and how to recognize multiple instances.

Example:
Definitions
Critical attributes

Structure
This type describes to the user what something looks like including identification of its individual parts.

Example:
Illustration
Conceivably a drawn picture of

Fact
This type is used when we need to communicate results, decisions specifications or research data.

Information types are useful if you don’t have source materials. It helps to flush out and reveal gaps.

Today we reviewed six of the most commenly used Informaation Types and how they are used. This also included a brief defination and a few examples. In Part 3 we will discuss the four Design Principles.

  • Chunking
  • Labeling
  • Relevance
  • Consistenacy

Design Principals provide a set of guidelines for the writers so the content they develop is structured and organized effectivly for the user.


Follow

Get every new post delivered to your Inbox.

Join 44 other followers