Software Frameworks, Architectural and Design Patterns

Part of the Dummies Cheat Sheet Style-Oriented Software Engineering

When you write a document and want to indicate the style of the program, make sure you provide your readers with enough information so that they can find the same style themselves. Program patterns appear in books, magazines, and conference proceedings, and should be cited like nothing else. Here are some guidelines:

The name kicked off. Within the document body, make the style name look different from the plain text in some way. Typically, style authors do this by applying lowercase formatting, underlining the style title, or continually capitalizing it.

Mark the pattern. Mark the pattern so that readers can find the complete pattern with a detailed reference. Use whatever reference method you apply to the rest of the document—footnotes, endnotes, or inline (with text in parentheses).

Trust all your sources. For each citation template, include all of the typical reference materials, such as the author, the name of the style, and where you found the style (eg a book or website). Sometimes enough people know the reference that you can use an acronym.

Release Date. Always mention the release date of the style you’re using, especially if your source can be changed and updated. Patterns on websites, for example, can be easily updated. Because writing styles is a never-ending process, styles are constantly being improved, and template authors list a new date for each new release.