Expert Python Programming - Third Edition

Design

The important point when creating such documents is to make sure the target readership is perfectly known, and that the content scope is limited. So, a generic template for design documents can provide a light structure with a little advice for the writer.

Such a structure might include the following:

• Title
• Author
• Tags (keywords)
• Description (abstract)
• Target (who should read this?)
• Content (with diagrams)
• References to other documents

The content should be three or four pages at most when printed, so be sure to limit the scope. If it gets bigger, it should be split into several documents or summarized.

The template also provides the author's name and a list of tags to manage its evolutions and ease its classification. This will ...