Solved

How to make Installation Manual

Posted on 2004-08-12
2
317 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
2 Comments
 
LVL 8

Author Comment

by:thomas908
Comment Utility
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 500 total points
Comment Utility

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

How your wiki can always stay up-to-date

Quip doubles as a “living” wiki and a project management tool that evolves with your organization. As you finish projects in Quip, the work remains, easily accessible to all team members, new and old.
- Increase transparency
- Onboard new hires faster
- Access from mobile/offline

Join & Write a Comment

Displaying an arrayList in a listView using the default adapter is rarely the best solution. To get full control of your display data, and to be able to refresh it after editing, requires the use of a custom adapter.
This is about my first experience with programming Arduino.
Viewers will learn how to properly install Eclipse with the necessary JDK, and will take a look at an introductory Java program. Download Eclipse installation zip file: Extract files from zip file: Download and install JDK 8: Open Eclipse and …
In this seventh video of the Xpdf series, we discuss and demonstrate the PDFfonts utility, which lists all the fonts used in a PDF file. It does this via a command line interface, making it suitable for use in programs, scripts, batch files — any pl…

744 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

Need Help in Real-Time?

Connect with top rated Experts

19 Experts available now in Live!

Get 1:1 Help Now