Sun StorEdge T3 Array Firmware 2.1

Documentation Set Plan

Network Storage Information Products Department

Document Last Updated: January 12, 2001


Contents

Why Read This Doc Plan?
Objectives
Schedule
Deliverables
Method of Delivery
Documentation Status
Review Process
Production Process
Localization
Issues/Risks
Assumptions


Why Read This Doc Plan?

This plan describes the overall strategy for the T3 array 2.1 documentation effort, including deliverables, issues, and schedule. Viability of this plan depends on your feedback.

Please send your comments, including corrections, additions, and suggestions to Sholeh Faramarzi.

T3 Array Documentation Staff
Sholeh Faramarzi, Lead Writer
Tim Smith, Writer


Objectives

The objectives of this documentation are to provide clear, concise, technically accurate, and easily-accessible information about how to install, administer, and operate the T3 array product.

New T3 Array 2.1 Features Planned for Documentation

Volume Slicing

LUN Masking

LUN Mapping

Auto Upgrade

Split Loop Mode


documented in the current doc set).

Host Side Initiators

documented in the current doc set).

Fabric Point-to-Point Support

Persistent Group Reservation (PGR)


 

New Features not Committed , but in the Plan

List of T3 Array 2.1 Documentation Deliverables
                1.   Sun StorEdge T3 Array Start Here
                2.   Sun StorEdge T3 Array Installation and Configuration Manual
                3.   Sun StorEdge T3 Array Administrator's Guide
                4.   Sun StorEdge T3 Array Controller Upgrade Manual
                5.   Sun StorEdge T3 Array 2.1 Firmware Release Notes
                6.   Sun StorEdge T3 Array Site Preparation Guide
                7.   Sun StorEdge T3 Array Regulatory, Safety Compliance Manual
                8.   Sun StorEdge T3 Array Field Service Manual
                9. Sun StorEdge T3 Array Disk Tray Installation Task Map

Related T3 Array Documentation Deliverables
                10.  18 Gbyte, 10K rpm, 1-Inch, Disk Drive Specifications, FC-AL Interface
                11.  36.4 Gbyte, 10K rpm, 1-Inch, Disk Drive Specifications, FC-AL Interface
                12.  73 Gbyte, 10K rpm, 1.6-Inch Disk Drive Specifications, FC-AL Interface
                13. 180 Gbyte, 7200 rpm, 1.6-Inch Disk Drive Specifications, FC-AL Interface New
 

The documentation set will include at least one new document to cover multi-LUN and LUN-masking capabilities. In addition, it will also require revising the existing 2.0 documentation set. Some of the manuals in this set will most likely, though not committed, be consolidated and restructured to further improve usability and to reduce the overhead of maintaining several small documents. The reason for this proposal is based on duplicate information in several documents, as well as inconsistent and unclear mapping of information across the documentation set.

T3 Array Documentation Set Contents

See Schedule.
 

T3 Array Documentation Set Contents

Document

Proposed Contents

Start Here

Roadmap to the documentation set.

Installation and Configuration Manual

Consolidates the existing T3 2.0 install and config guides into one manual. Will include pre-install, install, and post-install info all in one place.  Post-install will be the basic configuration needed to get the system up and running, as currently exists in the 2.0 configuration guide.

Administrator's Guide

Day-to-day operation and administration tasks beyond the minimum set up during the installation period.
Mostly multi-LUN, LUN-masking, and slicing features. It will also contain any type of configuration beyond the initial configuration that was done while installing the product. Both the contents and the title are TBD.

Controller Upgrade Manual

TBD.

2.1 Firmware Release Notes

Last minute notes prior to the release of the product.

Disk Tray Installation Task Map

TBD.

Site Preparation Guide

Mainly preparing the physical site before the arrival of the product.

Regulatory, Safety Compliance Manual

Safety conformity procedures.

Field Service Manual

Procedures for internal field services personnel use only.


Schedule

The following table shows the milestones for producing review drafts and for delivering the T3 array documentation based on three releases of the product: Alpha, Beta, and RR
 

T3 Array Documentation Review Schedule

Milestone

Comments

Target Date

 

 

Documentation Plan

Approved 2.1 documentation plan.

12/10, 2001

 

 

Alpha Doc Review Cycle

See Alpha Review Drafts and Deliverables. 

1/24 - 1/28 

 

 

Alpha Doc Delivery

 

1/31

 

 

Beta Doc Review Cycle

See Beta Review Drafts and Deliverables.

2/22 - 3/1

 

 

Beta Doc Delivery

 

3/8

 

 

RR Doc Review Cycle

See RR Review Drafts.

3/29 - 4/5

 

 

RR Doc Delivery

See RR Deliverables.

4/15

 

 

Post-RR

See Post-RR Deliverable.

6/1

 

 


 


Review Drafts and Deliverables

 Alpha Review Drafts and Deliverables

Alpha Review Drafts

Document Name

Deliverable

Contents

 

 

Installation and Configuration Manual

Draft 1

- Mainly framework of the doc.
- Completed outlines.
- Overviews.
-  2.1 FW upgrade procedure.

 

 

Administrator's Guide

Draft 1

- Mainly framework of the doc.
- Completed outlines.
- Overviews.
- Commands.

 

 

 Beta Review Drafts and Deliverables

 This will be the doc delivery for the beta release of the product.

Beta Review Drafts

Document Name

Deliverable

Contents

 

 

Installation and Configuration Manual

Draft 2

- More completed chapters, including new 
   commands.
- Will have place holders.

 

 

Administrator's Guide

Draft 2

- More completed chapters, including new 
   commands.
- Will have place holders..

 

 

Controller Upgrade Manual

Draft 1

TBD.

 

 

Site Preparation Guide

Draft 1

Will move the checklist to the install guide.

 

 

Regulatory, Safety Compliance Manual

Draft 1

Probably will remain static.

 

 

 RR Review Drafts

 This will be the last review drafts before RR.

Pre-RR Review Drafts

Document Name

Deliverable

Contents

 

 

Start Here

Draft 1

Roadmap for the documentation set.

 

 

Installation and Configuration Manual

Draft 3

All chapters completed. 

 

 

Administrator's Guide

Draft 3

All chapters completed. 

 

 

Controller Upgrade Manual

Draft 2

TBD.

 

 

Site Preparation Guide

Draft 2

All chapters completed. 

 

 

Regulatory, Safety Compliance Manual

Draft 2

All chapters completed. 

 

 

Disk Tray Installation Task Map

Draft 1

TBD.

 

 

2.1 Firmware Release Notes

Draft 1

Last minute product notes only.

 

 

 RR Deliverables

 This will be the actual RR delivery of the T3 2.1 documentation set.

Final RR Drafts

Document Name

Deliverable

Contents

 

 

Start Here

Final Draft

Roadmap for the documentation set.

 

 

Installation and Configuration Manual

Final Draft

Deliver the final draft for production.

 

 

Administrator's Guide

Final Draft

Deliver the final draft for production.

 

 

Controller Upgrade Manual

Final Draft

TBD.

 

 

Disk Tray Installation Task Map

Final Draft

TBD.

 

 

Site Preparation Guide

Final Draft

Deliver the final draft for production.

 

 

Regulatory, Safety Compliance Manual

Final Draft

All chapters.

 

 

2.1 Firmware Release Notes

Final Draft

Last minute product notes only.

 

 

18 Gbyte, 1-Inch, 10K rpm Disk Drive Specifications, FC-AL Interface

Final Draft

18 Gbyte disk drive spec.

 

 

36.4 Gbyte, 15k rpm, 1-Inch  Disk Drive Specifications, FC-AL Interface

Final Draft

36.4 Gbyte disk drive spec.

 

 

73 Gbyte, 10K rpm, 1.6-Inch Disk Drive Specifications, FC-AL Interface

Final Draft

73 Gbyte disk drive spec.

 

 

180 Gbyte,  7200 rpm, 1.6-Inch Disk Drive Specifications, FC-AL Interface

Final Draft

180 Gbyte disk drive spec.

 

 

 Post-RR Deliverables

RR Final Drafts

Document Name

Deliverable

Contents

 

 

Field Service Manual

Final Draft

All chapters.

 

 


Method of Delivery

This section describes how documentation will be delivered to the customer.
 

Method of Delivery

Title

Delivery

Media

 

 

Start Here

Web site, box

Print, PDF

 

 

Installation and Configuration Manual

Web site

PDF

 

 

Administrator's Guide

Web site

PDF

 

 

Controller Upgrade Manual

Web site

PDF

 

 

Disk Tray Installation Task Map

Web site, box

Print, PDF

 

 

2.1 Firmware Release Notes

Web site

Print, PDF

 

 

Site Preparation Guide

Web site, box,

Print, PDF

 

 

Regulatory, Safety Compliance Manual

Web site, box 

Print, PDF

 

 

Field Services Manual

Web site 

Print, PDF

 

 

18 Gbyte, 1-Inch, 10K rpm Disk Drive Specifications

Web site, box

Print, PDF

 

 

36.4 Gbyte, 10k rpm Disk Drive Specifications

Web site, box

Print, PDF

 

 

73 Gbyte, 10K rpm, 1.6-Inch Disk Drive Specifications

Web site, box

Print, PDF

 

 

180 Gbyte, 7200 rpm, 1.6-Inch Disk Drive Specifications

Web site, box

Print, PDF

 

 


Documentation Status

The T3 array 2.1 documentation set will require a complete documentation cycle that includes:

Updated illustrations.

One or two editorial reviews.

Updating localized documentation, including new document localization CD.


Review Process

Global reviews occur at major product dates, such as beta and RR. During global reviews, the current state of the documentation set will be available for review by the entire Purple team.

In addition to the global reviews, focused technical reviews should occur throughout the development cycle. These reviews identify key technical reviewers for a particular topic or topics. For large manuals, for example, a focused review process is probably the most efficient: sections will be distributed on an interim basis to key reviewers only. Global reviews occur at key product dates such as beta, however these reviews are not considered as the primary technical reviews.

The following have been defined as the key reviewers for the T3 array manuals:

Core Product Team Reviewers

Volslice code

Lun masking Code

EF code

NTP support


Production Process

The following guidelines might change depending on printing requirements, editorial support, art support, and so on.


 


 


Localization

Localization of documents will be handled by the product team using the assigned localization representative. The writers' commitment is to provide finished doc files in FrameMaker to the localization group for translation.

Writers will work with the L10N coordinator, Caroline Rodgers, to determine localization requirements.


Issues/Risks

Documentation Review
Documentation review must be thorough and completed by all assigned team members by the specified time. Incomplete comments or late comments will affect the documentation schedule (day-for-day slip).

Schedule Change
Engineering must lockdown the design and software development by "content freeze" dates shown in the schedule. Significant changes to design or software after these dates will affect the schedule. The milestones will be pushed out based on the number and magnitude of the changes required.


Assumptions

The following assumptions apply to the documentation development for this project: