For this blog entry, we were asked to review a set of poor instructions and comment on where the author went wrong.  For my part, I have found a clear example of a bad instruction manual on "How to Replace an Asphalt Shingle Roof".  I chose this example to review because I have experience replacing asphalt roofs and I know the steps involved.  Included is a diagram of a roof for clarification.


 

The first thing that I noticed, when viewing the instructions, was that there are no visuals to help the reader understand what is happening or how to accomplish subtasks. For these particular instructions visuals are needed, as most readers will not be familiar with how to make a cap shingle, how to use a starter shingle (or even what they look like), or how to properly lay a shingle.  All of these aspects of roofing are very important in installing an effective and visually appealing roof and should be covered more than just in passing.  For example a starter shingle is a common three tab shingle which has been augmented so that the tabs are removed, leaving only the tar line and the backing.  The tar line is placed at the edge of the roof (over the drip edge) so that the first visual shingle will adhere and seal to the plywood decking.  This row must be placed correctly because if it is not, the shingles above will run crooked. 


Another aspect of roofing that was missed in this instruction set was the placement of felt paper.  This component of roofing is necessary to protect the plywood decking from water damage.  The selection of the correct type of felt paper is also not necessarily easy and straight forward.  Sometimes you will need to use Ice and Water shield, depending on the pitch and lay of the roof.  This is not even mentioned in the instruction set at all. 


The nailing pattern is adequately covered in the text of steps but pictures showing this would have been useful to the non professional installer as most are not familiar with what a water line is. The application of drip edge, which wraps the perimeter of the roof, is mentioned in passing but its application or use is not discussed.  Also a necessary roofing component, it should have been covered.

Continuing shingle up the rake of the roof is covered because these shingles are laid down exactly as the first row of shingle covered in the starter shingle section.  Another problem arises when all the shingles are down and now only the roof's ridge is exposed.  The instructions correctly refer to cap shingles to complete the job but most readers won't know that there is no such thing as a cap shingle on the market.  These caps must be manually made from three tab shingles.  While the process is discussed, pictures would have clarified more effectively.

The last two arguments I have with the text of this instruction set is that the author calls for the use of roof tar in between shingles and that the instructions don't cover weaving shingles in valleys.  First, tar is not necessary if the shingles are laid properly and it is very messy and unsightly if used.  Tar should only have to be placed on the last two nail heads in the last cap shingle on the ridge of the roof because these should be the only two nails exposed to the elements.  Lastly, this instruction set completely omits steps required if there is a change in the roof line.

Now that the actual instruction text is reviewed, the presentation and structure of the set must be looked at.  Markel talks in length about how to structure an instruction set, but this author has clearly never heard of Markel's book on technical communication.  Some of the blatant violations of Markel's rule for instruction sets include the lack of graphics to communicate a process, the lack of white space in the body of the document, no headings are used, and there is no list of materials and tools required.  The author does number the steps, recommended by Markel, but sub steps should have been used to provide more complete information.

In closing, How to Replace an Asphalt Shingle Roof is a good example of a bad instruction set.  It seems to be useful if and only if you already know how to replace a roof or if you don't care about how your project will turn out.  If you are set on replacing your asphalt roof yourself, I suggest that you look for directions elsewhere.

Technical Imagery

| 0 Comments | 0 TrackBacks
A technical document may, at times, be written for experts who will understand short hand notation and jargon relating to the field of interest.  Sometimes, however, these documents will be used by laypeople who will probably not understand everything.  One way to aid a layperson in understanding concepts is to incorporate imagery into the document.  Many people are visual learners and a good diagram may convey more information than a block of text.

As an example of this, I have found an online article about how to wire a 3-way light switch.  To view this article click here.  Having worked in the residential construction for several years, I felt that I had sufficient knowledge on how to perform this task, but as it turns out, I did not.

There are eight ways to wire a 3-way switch, of which I am familiar with two.  Each distinct wiring configuration serves a different purpose or application which the end user might encounter.  The article provides a material list so that a do-it-yourself person will know if they are properly equipped, a short block of text describing each of the eight diagrams, and a diagram for each situation.

The diagrams and text are used to support one another, with the diagram a user can identify visually what they will be dealing with in reality.  Actually seeing what has to be done while having some supporting text for clarification make it possible for this article to teach anyone how to wire a 3-way switch, which is not an easy task.  I believe that it is the clear images provided that make this possible.  As you can see below, all the wires are color coded as they are in reality, all switch components are labeled and wired, and all wire nut connections are included.  This complete picture makes it difficult to not wire correctly.
Wiring Option 3

In this example, I hope to have shown how the use of images can enhance the transmission of information in a technical document. 

Spoof on Copyright laws at Disney's Expense

| 0 Comments | 0 TrackBacks
Click here.

Copyright Laws: Adequate or Unrealistic

| 0 Comments | 0 TrackBacks
After listening to an NPR interview with Lawrence Lessig, the author of Remix: Making Art and Commerce Thrive in the Hybrid Economy, I began to examine my own personal opinions regarding the copyright laws in place today.  Unbeknownst to me, I actually have some strong feelings about this particular topic. As it turns out, I agree with Lessig's line of logic pertaining to  copyright laws and how they are completely irrelevant in today's lifestyle.  
The first thing that I found interesting in the interview was the comparison of the war for prohibition and the war against file sharing.  While these two topics are overwhelmingly different by nature, the principles behind them are fundamentally the same: Denying the vast majority something they want.  Prohibition ultimately failed and Lessig believes that the copyright laws of today will follow suit. Another similarity between the two is the policing of policies, how can you enforce such restrictions?  You can't and this is why I agree.  If you can not effectively enforce a law then it is rendered useless and insignificant.

The second point I found particularly interesting was the power celebrities have over legislation because of their money and fan base. This really sets me off because I personally don't think that the majority of musicians, actors, or athletes deserve the money or privilege that they receive.   Many are highly uneducated people who provide nothing but simple entertainment to the mass public.  They're modern day jesters, clowns for our amusement and I don't believe that this minority should have more representation in congress that the working people who make this country what it is.  Lessig presents an example of this unfair representation in the interview.  The United States Constitution gives congress the ability to establish the duration of copyright protection but states that it has to be for a finite period of time, which it has.  The problem lies in congress' ability to amend and extend that duration at will, which it also has.  In fact, congress has extended the laws 11 times in the past 40 years alone, allowing these people to reap more and more profit from the creative work.  What about scientific patents or scholarly papers?  Are these being extended?  I don't know but I'm sure they are not as stringent as those protecting entertainment property.  

Mash-up music was also discussed during the interview, particularly the debate of whether the mash-up artist has the rights to revenue from the distribution of the work or if the original artists have the right to that revenue.  A mash up, such as "If I were a Free Fallin' Boy" by Dj Earworm found here, is entirely comprised of copyrighted material but the end product is completely distinguishable from the original works and did not exist before.  I personally believe that the mash-up artist should be entitled to the revenue but legally they must pay royalties, generating extra income for the original artists.
  

I relate this, probably illogically, to the people who originally discovered any musical chord.  Does there estate deserve to be compensated by every person who ever used their original work?  No because that would be impossible to do and it would be extremely ridiculous. As with them, so the entertainment industry should follow.  After a period of time, songs, movies, radio broadcasts, ect. should become public domain and should be freely traded.

To conclude this entry by saying, this little rant is just a portion of my opinion on the copyright system set up today and I urge everyone to give Lawrence Lessig's NPR interview a listen and see if it doesn't draw out similar emotions.  The interview can be found  here.  
Also, give special attention to his solutions to the problem of file sharing.  Sounds a little like iTunes, Ruckus, and many other pay per share software to me. 

Note:  I believe that I "stole" the images used in this entry, breaking copyright laws.

On-line Portfolios

| 0 Comments | 0 TrackBacks
In the past two years I have created at least two on-line portfolios.  The purpose for the first portfolio was to fulfill the application requirements for the Schreyer Honors Program.  This portfolio included samples of my written and presentation ability, along with actual graded tests from my first two years of college.  Since I was accepted into the program, I have abandoned this webpage.  The second portfolio I made was for a numerical analysis class that I took in the spring of 2009.  This one was a little different in that it only showcased my abilities in numerical analysis and web design.  Since completing the course, I have removed the website because it serves no purpose to me anymore. 

I plan on making a professional web portfolio, which I will maintain after school, in my English 202C course.  Now that I have a little experience, I fell that it will be the best one.

Faraday's Cage is Where you put Schrodinger's Cat

| 2 Comments | 0 TrackBacks

If you have ever wondered what entertains an engineer, you probably haven't, then just read Faraday's Cage is where you put Schrödinger's Cat at http://mareserinitatis.livejournal.com/.  The purpose of this blog is not only to entertain the average technical person but also to inform him/her of current events and scientific breakthroughs.

Scattered throughout this professional engineering blog are current events articles taken from reputable publications on topics ranging from the current controversy about the gun scopes with proverb inscriptions all the way to complex math regarding Fourier Transforms and Signal Processing.  This nice mix of information and relief is why I believe this blog flows so well.  With comedy in the form of videos, cartoons, sound clips, and links to other web pages, the reader is able to take a break from the material that has to be concentrated on and just navigate leisurely.   

The tone of the writing is fitting for a technical person who may just be browsing the internet for something to read.  Its light hearted at times but can also be very serious when necessary. The author does a nice job of distinguishing between two, so that the readers can have an easy transition from one topic to another.  Also, the random comic strips inserted in between the articles act as a sort of palette cleanser, preparing the reader for the transition to another topic.  This is the design feature of which I appreciated the most.

Overall, this blog has a nice flow, great content, and a style fitting for its purpose.  I guess that's why it is the 17th ranked top engineering blog.

New design launched using Movable Type

| 0 Comments

My web site is sporting a new look and feel thanks to the Blogs at Penn State and the Portfolio Template Set. This template makes it possible for just about anyone to get up and running with a new web site using the Blogs at Penn State. It is literally as easy as just a few clicks. Just pick a new for your web site, select the Professional Template Set and publish. Then viola! a new web site. Thank you Blogs at Penn State!

Search This Blog

Full Text  Tag