Web Development·12,095 discussions

Type of Documentation from Application D

Locked

I am responsible for putting together an industry accepted document to capture all information that must be shared between an Application Developer and the Network Administrator during all phases of life-cycle. Our platforms are Windows NT & Unix based. We use client & web based applications. What are the five (5) misssion critical pieces of documentation that should be shared between the application developer and the NT Admin. Thanks.

Topic

Type of Documentation from Application D

In reply to Type of Documentation from Application D

I am not sure where the number 5 came from, but here are some typical things a developer should let an admin know before an installation or upgrade:

1) Hardware requirements: disk space, RAM, etc.
2) OS version, DDL versions, shared library versions needed.
3) Is a reboot or other downtime needed? How much downtime?
4) Are any data conversions of exsting files or data needed?
5) Are there any registry, ini file, configuration file, or environment changes needed?
6) Can the install or update be uninstalled or rolled back?
7) How long should the install take? How can you tell if the install succeeded? What to do if the install failed?
8) What know bugs are there with the system? Who should handle support calls?
9) What web browsers and versions are supported?

There are probably a lot more issues that need to be addressed, but the above list can serve as a start.

Type of Documentation from Application D

In reply to Type of Documentation from Application D

Thanks Wayne M.

While this is not exactly what I would call mission critical documentation points, this did help me somewhat in formulating additional questions that open dialog between our Application Development & Network Systems Teams. Thanksagain!

[Author]

Replies