Skip to content

A LaTeX package extending enumeration and providing macros for use in writing "Intent Specification" style requirements documents.

License

Notifications You must be signed in to change notification settings

akamai/intentspec

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Purpose

IntentSpec is a LaTeX package to facilitate writing requirements documents in the "intent specifications" style described in Nancy Leveson's paper, "Intent Specifications: An Approach to Building Human-Centered Specifications".

Contents

  • intentspec.sty - A LaTeX package you can include in your LaTeX documents.
  • intent_specifications_example.tex - An example document to look at and compile.

Features

  1. macros for citing and linking to another “iitem” with an arrow
  2. modification of the enumeration environment to include a specified prefix
  3. an “intent item” (iitem) macro to include four parameters: (a) a label to be used when citing this item elsewhere in the document (b) a short description (which appears in bold) (c) a longer description of the item (d) a place to cite other related intent items

Example

For a demonstration, look at intent_specifications_example.tex and compile it with the following commands:

latex intent_specifications_example.tex latex intent_specifications_example.tex dvipdf intent_specifications_example.dvi

Then open the resulting PDF in a viewer of your choice.

Caveat

For cross-referencing to work, you will need to compile the LaTeX multiple times.

About

A LaTeX package extending enumeration and providing macros for use in writing "Intent Specification" style requirements documents.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages