Guidelines for Composing a Field Description

  Previous section   Next section
  • Use a statement that accurately identifies the field and clearly states its purpose.

  • Write a clear and succinct statement.

  • Refrain from restating or rephrasing the field name.

  • Avoid using technical jargon, acronyms, or abbreviations.

  • Do not include implementation-specific information.

  • Do not make this description dependent upon the description of another field.

  • Do not use examples.


Part II: The Design Process