?
Solved

How to make Installation Manual

Posted on 2004-08-12
2
Medium Priority
?
333 Views
Last Modified: 2010-04-17
I am supposed to make a Installtion Manual for a Java application.
Can someone please give me some templates or guidance or  information on how to go about it?
Thanks
0
Comment
Question by:thomas908
[X]
Welcome to Experts Exchange

Add your voice to the tech community where 5M+ people just like you are talking about what matters.

  • Help others & share knowledge
  • Earn cash & points
  • Learn & ask questions
2 Comments
 
LVL 8

Author Comment

by:thomas908
ID: 11790534
I have thought about following templete, I don't know if it's OK

1.      Introduction

         1.1       Purpose

2.      Application Source files    
3.      Third Party Jar Files
4.      Third Party DLL Files
5.      Miscellaneous Files
6.      Runtime Environments
7.      Database Installation, Data Files and Connectivity
8.      Running the Application
0
 
LVL 3

Accepted Solution

by:
aravindtj earned 1500 total points
ID: 11790582

hi,
try this.
this is from ....

Table of Contents
http://www.klariti.com/templates/Installation-Plan-Template.shtml


1    Introduction
1.1    Purpose of this document
1.2    Objectives
1.3    Identification
1.4    References
1.5    Relationship to other plans
1.6    Key Stakeholders
1.7    Points of Contact

2    Installation Plan
2.1    Overview
2.2    Scope
2.3    Environment
2.4    Tasks
2.5    Security
2.6    Site Specific Information
2.7    Site Name [x]
2.7.1    Schedule
2.7.2    Software Inventory
2.7.3    Hardware Inventory
2.7.4    Network Inventory
2.8    Installation Procedures
2.9    Entry and Exit Criteria
2.10    Backup Procedure
2.11    Change Control Procedure
2.12    Installation Test Procedure
2.13    Constraints
2.14    Issues
2.15    Assumptions
2.16    Dependencies
2.17    Resource Requirements

3    Training

4    Project Management
4.1    Roles and Responsibilities

5    Appendices
5.1    Glossary of Terms
5.2    Acronyms and Abbreviations


Index of Tables
Table 1 — Tasks
Table 2 — Constraints
Table 3 — Issues
Table 4 — Assumptions
Table 5 — Dependencies
Table 6 — Schedule
Table 7 — Roles and Responsibilities
Table 8 — Glossary of Terms
Table 9 — Acronyms and Abbreviations


Try the following links also...

http://www.hud.gov/offices/cio/sdm/devlife/tempchecks/umtemplate.doc
http://asds.stsci.edu/ASDS_sample_template.html
http://wwweic.eri.u-tokyo.ac.jp/computer/manual/lx/SGI_Developer/books/FLEXlm_PG/sgi_html/ch13.html
http://e-docs.bea.com/platform/docs81/isv/docs.html

All the best
0

Featured Post

Optimize your web performance

What's in the eBook?
- Full list of reasons for poor performance
- Ultimate measures to speed things up
- Primary web monitoring types
- KPIs you should be monitoring in order to increase your ROI

Question has a verified solution.

If you are experiencing a similar issue, please ask a related question

Whether you’re a college noob or a soon-to-be pro, these tips are sure to help you in your journey to becoming a programming ninja and stand out from the crowd.
Computer science students often experience many of the same frustrations when going through their engineering courses. This article presents seven tips I found useful when completing a bachelors and masters degree in computing which I believe may he…
Six Sigma Control Plans
Progress
Suggested Courses

752 members asked questions and received personalized solutions in the past 7 days.

Join the community of 500,000 technology professionals and ask your questions.

Join & Ask a Question