DISCUSS: A Technical Document Should Follow an Outline

Nov 10, 11 • technical writingNo CommentsRead More »

“What’s in a name? That which we call a rose by any other name would smell as sweet.” ~ William Shakespeare

I’m the first to say to break the rules. However, there are times that you are not really breaking a rule, but creating a new one. In technical writing, there are different types of documentation that are created to support a project. These documents have a default structure that are known and accepted as the norm. You can modify the structure to fit your needs.  However, if the structure is drastically different than the default outline, then you are creating a new document type.  This is my feelings on this.  However, I’ve noticed that others don’t feel that way.

What are your thoughts? If you call it a Functional Requirements Document (FRD), but the structure doesn’t look anything like one, is it still a FRD?

51861833178450668 jBqLw0XJ c DISCUSS: A Technical Document Should Follow an Outline

Source: vanlier.co.nz via Katie on Pinterest

Tags: , ,