package documentation

  • Can anyone provide me with sample template for package documentation? At present, I am writing like this:

    1.

    1.1

    1.1.1

    and then thinking to add visio diagrams..any better methods that anyone can suggest?

  • I try to make packages self-documenting, with plenty of annotations, and tasks named to be descriptive of what they do. If you number your tasks as well, you can refer to them more concisely in your annotations, and it also means you can have the same name for more than one task. If you do all that, you only need a few lines in your solution document to describe the what, why and how of the package.

    John

  • Don't forget the description field. It's useful for putting more detail about objects as needed.

Viewing 3 posts - 1 through 2 (of 2 total)

You must be logged in to reply to this topic. Login to reply