Archive for the ‘John Crews’ Category

What is a Structured Document?

Monday, March 22nd, 2010 - Posted By: John Crews

This is a question commonly asked by our customers when we begin working with them on a single-source solution.  There is a short answer:

A structured document organizes paragraphs (elements) in a logical hierarchy, provides a means to attach tags (attributes) to individual paragraphs (elements), and gives you the ability to view the document in multiple ways.  FrameMaker ® (and other editors) also gives you the ability to manipulate the content of structured documents so that you can supply different outputs from the same document.

For this discussion, I will be using Adobe® FrameMaker® as my editor.  FrameMaker’s what-you-see-is-what-you-get view of structured documents is called the Document View.  If you have worked in unstructured Frame, this should look very familiar:

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Note, that all text is enclosed in brackets.  These brackets indicate element boundaries on the WYSIWYG view (Document View).  This correlates to the Structure View hierarchy described later.

The second way to view the document is called Structure View in FrameMaker.  The Structure View shows all elements (paragraphs) arranged in a hierarchy.  Each box represents an element.  An excerpt of the element text is displayed to the right of the element.  Below each element are Attributes assigned to the element.

The example highlighted below shows that the first element Bullet1 is assigned a value of 1 for the attribute Output.  The second element Bullet1 is assigned a value of 2 for the attribute Output.

In addition to managing the attributes and hierarchy of elements, you can also perform some edits in the Structure view.  If you right-click on an element, a context menu appears that describes several possible actions.  Typical shortcut buttons (ctrl+C for copy, ctrl+v for paste) function normally.  You can also drag-and-drop elements to move their location or to change their place within the hierarchy.

Most users who are accustomed to unstructured FrameMaker are used to working with the formatting toolbar.  Structured Frame does have this functionality; however, it also introduces an Element Catalog in place of the paragraph catalog.  The Element Catalog lists elements that may be selected to insert into the document and provides a tool-set for managing elements as you create them.  Using this catalog, you can insert an element into an existing element, wrap an existing element inside of a new element, and change the type of an existing element.  This tool set helps to minimize the complexity of managing the content from the Structure View.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Once you have an element in place, you can assign attributes using the Attribute Editor.  The editor displays potential attributes for a selected element and lists the predefined values that may be assigned.  Select the desired attribute, assign an attribute value, and then select the Set Value button.  This assigned value is then visible in the Structure View.

 

 

 

 

 

 

 

 

 

 

Using the Structured FrameMaker tool set helps to make management of complex single-sourced documents easier.  Creating a functional hierarchy allows you to manage content at all levels.  Attributes allow you control several output levels and types while ensuring that you are able to maintain accurate content.

Import Images by Reference – Advil for Drawing Revision Headaches

Wednesday, March 10th, 2010 - Posted By: John Crews

Our Customers Ask…

“Our company frequently revises our engineering drawings.  Several of these drawings are included in our product guides.  How can we efficiently ensure that the latest drawings are included in our manuals?”

PPI Answers…

We use a repeatable method to ensure that our customers’ latest drawings are always included in documentation.  The key lies in the way we import images.

When you insert a drawing into an Adobe® FrameMaker® document, you have the option of either embedding or referencing the image file.  If you select the embed option, the file is imported as a static part of the document.

Instead, selecting the Import by Reference option tells FrameMaker® to check the source file each time you open the document.  This means that if you change your drawing, save it in the same location by the same name, then FrameMaker® will display the updated image next time it opens the document. 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Voila! Automatic drawing updates!   The tricky part is building a sustainable file structure that allows you to manage the images while retaining revision control.  Most organizations use the name of their drawing files to track revisions.  This can still be done while setting up a file structure that promotes referencing vs. embedding image files.

 A common file structure might look like this:

Each file name includes a brief description of the file and shows what revision.  Users can tell at a glance what file is the latest revision.

 In order to make the best use of the Import by Reference option, you might consider adding an Active folder to your file structure.  The files in the Active  folder should not have the revision information in the title.  For example

 

 

When you update a drawing, follow these steps;

  1. Save the file as you normally would.
  2. Save a copy of the drawing to the Active folder
  3. Rename the file so that it has the same name as the previous revision.  This way, FrameMaker knows what drawing files should be displayed. 

Managing your files this way saves you the nightmare of hunting through existing documents and replacing images every time a drawing is revised.

Conditional Formatting vs. Attribute Filtering in Single-Sourced Documents

Friday, March 5th, 2010 - Posted By: John Crews

Many of our customers come to us because they see the value in single-sourcing their documentation.  Of couse it is simple and cost-effective to maintain a single document that provides multiple outputs – much simpler than trying to juggle multiple individual files. 

When designing the single-source document, one of the first considerations has to be how you will manage the content.  To this end, there are two primary methods:  Conditional Formatting and Attribute Filtering.  What is the difference between the two?  What circumstances would make one more appropriate than the other?  These are some of the questions that we are frequently asked.  To address these questions, let’s take a look at each of these methods.  For these examples, I will be using Adobe® FrameMaker® as my editor.

Conditional Formatting

Conditional tags can be applied to individual characters, words, sentences, or whole paragraphs.  You can then display or hide the tagged text within the document with a few clicks of the mouse.

Before you begin to write your document, make a list of the conditions that you may need to set.    For the purposes of this example, I have identified two conditions: Condition A, and Condition B.  Once these conditions are identified, you can create condition tags.  Some editors allows you to designate text colors that will be displayed once a tag is applied.  These colors are called Conditional Indicators.  You can turn these indicators off globally before you print or export your document.   I chose to use Green for Condition A and Red for Condition B.

As you develop your document, mark content that you would like to manipulate with a conditional tag.  First, select the text, and then apply the predefined conditional tag. 

  

Once your document is complete, you can manipulate it by showing or hiding certain conditions.  In the example below, I have hidden both Condition A and Condition B. 

 

 The next example shows Condition A and hides Condition B.

 

This method of manipulating a single sourced document makes it easy to manage multiple input combinations; however, it does not lend itself well to multiple output levels.

Attribute Filtering

Attribute Filtering provides more options than conditional formatting; however, it is applied at a higher level.  Where conditional text could be applied to a single character, word, or sentence within a paragraph, attributes are applied to the paragraph itself.  If you have to change just one character in a paragraph in order to achieve the desired output, you will need to duplicate the paragraph, make the change, and apply different attributes to each.

To apply attributes, you must be working in a structured document.  As you develop your content, set the appropriate attributes and their values.  For example, you could have an attribute of “Condition” with possible values of “1“and “2.”  Additionally, you could have an attribute of “Level” with possible values of “A “and “B.

  1. Attribute = Condition
    1. Value = 1
    2. Value = 2
  2. Attribute = Level
    1. Value = A
    2. Value = B

Once your attributes are assigned, you can develop filter expressions.  Filter expressions are Boolean expressions that dictate what content is displayed or hidden.  Some possible filters for the above attributes and values are:

1. Common Text Only:

NOT (Condition=”1” OR Condition=”2”) AND NOT (Level=”A” OR Level=”B”)

2. Condition 1 + Level B

NOT (Condition=”2”) AND NOT (Level=”A”)

3.  Condition 2 + Level A

NOT (Condition=”1”) AND NOT (Level=”B”)

4. Level B only

NOT (Condition=”1” OR Condition=”2”) AND NOT (Level=”A”)

As you can see, attribute filtering is a powerful means of controlling various outputs; however, it works best when there is a singular input.

To further illustrate, let’s take a look at two hypothetical clients.

Hypothetical Client A

Client A produces one basic type of heavy industrial equipment; however the machine is customized for each customer.  There are 82 possible features and options, giving them an almost limitless potential for customization.  It is impractical to pre-write individual user manuals and product guides for every potential configuration.  It is ineffecient to create a draft-to-print custom manual and guide for each possibility.

The output will always be either a pdf or a printed document, and will always be delivered to a consistent audience level.

Using conditional text is the correct answer in this case.  The output is always the same level (ie. there is only one audience), it is the input that changes.  Manipulating the document by setting conditions allows you to precisely control the features and options that are included.

Hypothetical Client B

Client B produces a few different industrial machines.  Each machine requires three levels of publications: a Product Operation  Guide, a Preventative Maintenance System, and an Installation Manual.  Each of these manuals will focus on different aspects of the same machine.  Some of the content in each will be common; however, the steps that are required for various processes will vary greatly from one user level to another.

In this instance, the input is constant while the output changes.  Attribute filtering would be appropriate for Client B.  Manipulating the document by filtering attributes allows tight control over the documents that are produced, ensuring that the correct information gets to the correct audience level.

Choose Wisely

Each of these methods requires a different approach to writing your document.  Before you begin to develop your content, ensure that you have selected the best method of managing content.  Choosing correctly makes it easy to produce the desired results.

HALO Jumping, Recession, and Training… Oh My!

Thursday, September 17th, 2009 - Posted By: John Crews

HALO (High Altitude Low Opening) skydiving is a technique used by special operations military units in order to covertly insert troops into strategic areas.  The soldier begins the process 25,000 to 35,000 feet above the Earth.  (S)he exits the aircraft and immediately begins to accelerate towards the ground.  Within 15 seconds, the jumper is traveling at speeds close to 200 miles per hour.  The soldier does not open a parachute to slow decent until (s)he is around 3,500 feet from the earth.  Once opened, the chute (and physics) begins to decelerate the rate that the person is falling; however, (s)he still impacts the surface traveling very fast.

I would imagine that there is a very critical time period beginning when the chute is deployed and ending when feet touch the ground.  During this time, the soldier must accomplish several things.  The jumper must do an immediate self-check for signs of decompression sickness, ensure that his/her orientation with surface directions is correct, quickly take stock of the battlefield, be aware of communication and orders, ensure that necessary resources are at hand (and have survived the jump), and decide what direction to move when the jump is completed.  If all of this information is processed correctly, the HALO jumper will be able to hit the ground running (so to speak) and will be able to realize the full potential of the advantages presented by the HALO jump.

Over the past year, we have all been riding this recession.  Some may have felt not-unlike a HALO jumper.  Although the recession seems to have turned the corner, the ride isn’t quite over yet.  Right now is a critical time for businesses, and we would do well to follow the example of the jumper during that critical period between deployment of the parachute and touchdown.

Check for any signs of ‘decompression sickness.”  The past year took its toll on virtually every organization.  Most of us are acutely aware of the financial price we have paid over the past year, but look a little deeper.  How does employee loyalty measure up to 2008?  What about morale?  How has your customers’ perception of your organization changed? 

Check your orientation.  Many businesses have been in survival mode, operating as lean as possible.  Ensure that key managers are aware of the differences between lean operation, recovery operation, and growth operation.  This will be important as your organization begins to recover and moves back towards growth. 

Take stock of the battlefield.  During the recession, have your objectives changed?  Do you see a better direction in which to move your organization?  Have you developed any innovations that may lead you towards new successes?  Not unlike our HALO jumper, we have a just few heartbeats to take stock of how our corporate battlefield has changed and designate new objectives if necessary.

Be Aware of Communication and Orders.  It is critical that each of us pays more than the usual attention to communication right now.  If new corporate objectives are established, that information must filter throughout the organization in order to facilitate a smooth transition from survival through recovery and into growth.

Ensure that necessary resources are at hand.  How many organizations were forced to downsize their workforce and delay necessary equipment upgrades?  What adjustments are necessary to meet customer requirements enough to allow the transition from survival mode to recovery mode?  What defines the point when your organization will officially move into recovery?  Further, what resource adjustments are necessary in order to move back into growth mode, and what point will define the switch from recovery to growth?

Transitioning into recovery mode will not necessarily be easy.  We are all going to have to overcome several challenges as we rise out of this recession.  For example, your organization may need to see an increase in revenue before you are able to expand your workforce.  You may be operating on a skeleton crew at this point.  How will you, with lean resources, increase revenue before you are able to enhance/replenish your resources?  Further, consider the challenges associated with training new team members when you are able to augment your survival-mode crew.

The key here is training – training new team members, cross training existing team members, training existing team members for roles of higher responsibility… we are all going to have to pay close attention to our training efforts.

PPI Technical Communications does have needs assessment and training services available; however, if you are going to develop your own training, the following 7 steps will help to organize the development process and ensure that your training is comprehensive:

1. PLAN – Identify training goal, Training Program Terminal Objective, target audience, content type, course type, method of delivery, and material requirements. PPI recommends creating a Training Program Plan document that captures the above components to be used as a reference when communicating the vision to development staff.

2. ANALYZE – Analysis and organization of information, including Training Program content and Training Program plan. Identification of Training Program Enabling Objectives (stepping stones) that will logically lead trainees to the Training Program Terminal Objective

3. DESIGN – Organization of Training Program into Courses, then Classes. Development of Course Terminal Objectives and Enabling Objectives that facilitate incorporation into the Training Program Terminal Objective and meet the Training Program Enabling Objectives. Development of Class Terminal Objectives and Enabling Objectives that facilitate incorporation into the Course Terminal Objective and meet the Course Enabling Objectives.

4. DEVELOP – Develop the training content as required in order to fit the Training Program Design and Plan.

5. IMPLEMENT – Pilot the training program

6. EVALUATE – Evaluate the Training Program, considering the results, instructor input, and trainee input.

7. REVISE – Revise the Training Program to streamline delivery and maximize effectiveness.

What direction will your organization move in when your feet touch the ground?

 

 

 

The Value of Service

Wednesday, August 5th, 2009 - Posted By: John Crews

 

Value Vs. Cost

Today, many companies are struggling to find ways to become more competitive.  One of the most common methods is to drastically slash prices.  This method may increase sales, but is it really increasing your revenue?

In order to make your prospective customers aware of your price reduction, you actually have to spend more money on an advertising campaign.  It does not make a lot of sense to spend more in order to generate less revenue.

This method quickly leads to an increased importance of quantity at the expense of quality.  Large companies that are focused on accumulating a large quantity of residual income generating customers have shown a disconcerting trend – when sales efforts are largely successful, customer service falls by the wayside. 

Lowering the cost of your service is easy to do - so easy, in fact, that your unimaginative competition can do it too.  There is an alternative to lowering the quality of your service offering in order to
reduce prices.

Helping Customers to Help Themselves

It is extremely cost effective to hire a contracting company to perform a service.  The benefits of retaining contract specialists and service providers are well known.  However, there is a down-side.

When a service provider acts as a consultant and teaches their clients how to manage their services on their own, the service provider then loses their ability to retain that customer.  The end result is that a longtime business relationship between a client and a service provider must be based on secrecy.

One way to increase the value of the service that you provide is to add an educational element to your service.  Your customers will be more willing to invest in your service if you teach them to do
it themselves.

A slight shift in perception is required.  Take yourself from an ongoing service provider to a one-time service provider that includes training.  Generate your cost estimates based on the income that your company needs to complete a project and to develop and deliver training to your customers. 

You will see that you are able to increase the perceived value without decreasing your prices.  Your customers will gain  knowledge that allows them to minimize future expenditures.

PPI has taken this approach with SCULPTCM by creating an initiative that enables us to simultaneously provide three valuable services to our customers: implement a comprehensive custom solution, define a toolset that is optimized for the management of that solution, and provide training that allows our customers to manage their solution on their own (post implementation).

Our economy dictates that companies minimize their expenditures.  Companies are going to do that whether service providers like it or not.  Forward-looking service providers should see this as an opportunity to move into a new direction.


View John D Crews's profile on LinkedIn