more wikis
 

0000-0000-naming conventions macro test3

From Scratchpad

Contents


Title page

File:0000-0000-naming conventions macro test3 01.png

Table Error! No text of specified style in document. 1

File Naming Conventions

0000-0000-naming_conventions.doc

Speakeasy Proprietary

This document and all information and expression contained herein are the property of Speakeasy Inc., are loaned in confidence, and may not, in whole or in part, be used, duplicated, or disclosed for any purpose without prior written permission of Speakeasy, Inc.

This document is an unpublished work.

Copyright 2008 Speakeasy Inc. All rights reserved.

Purpose

This document defines the file-naming conventions for Speakeasy engineering documents.

Revision History

Version Date Author Change Description
1.0 14 July 2008 Donny Wheeler First draft
       
       
       

Table of Contents

List of Tables

List of Figures

[edit] File Name Format

Required elements in the filename provide:

  • Search ability
  • Manageability
  • Indication of content
  • Position in product hierarchy.
File:0000-0000-naming conventions macro test3 02.png

Table Error! No text of specified style in document. 2

Figure Error! No text of specified style in document. 1 File Name Format

Example:

0000-0000-naming_conventions.doc

The example deconstructs in this manner:

File:0000-0000-naming conventions macro test3 03.png

Figure Error! No text of specified style in document. 2 File Name Example

Craig, need info

Can you provide some info on program and dept names? And, I may be missing a sequence in the name. It seems to me a third number block might be useful.

The sequence should describe the file as a member of a program, the dept within the program, and an indicator to its contents.

The type can be further refined by incrementing the prog and dept numbers, e.g. 2000 to 2001 and 2002.

Do not uses spaces to separate the numeric blocks within a file name; substitute a hyphen (-) instead. Use an underscore (_) to separate parts of the alpha name.

[edit] Determining Appropriate Name

The first number block will be assigned by the program manager. The following table lists the possible choices for the second block in the sequence (department).

Table Error! No text of specified style in document. 3

Table Error! No text of specified style in document. 4 Department Numbers (second block in sequence)


Program Number Department Number
Program 1 (assigned) 1000 Department 1 1000
Program 1 (assigned) 1000 Department 2 2000
Program 1 (assigned) 1000 Department 3 3000
Program 1 (assigned) 1000 Department 4 4000
Program 1 (assigned) 1000 Department 5 5000

Differentiate various document types by incrementing the department number, as demonstrated in the following table.

Table Error! No text of specified style in document. 5

Table Error! No text of specified style in document. 6 Department 1 Document Types


Document Type Number (incremented second block)
Subtype 1 2001
Subtype 2 2002
Subtype 3 2003

Note

The zero designation is reserved for templates. Other type designations TBD.

[edit] File Locations

Use the following table to determine the appropriate storage location for engineering files.

Table Error! No text of specified style in document. 7

Table Error! No text of specified style in document. 8 File Locations


What Where
1000-0000-xxxx /some/server/location
1000-1000-xxxx /some/server/location
1000-2000-xxxx /some/server/location
1000-3000-xxxx /some/server/location
1000-3001-xxxx /some/server/location
1000-3002-xxxx /some/server/location
1000-3003-xxxx /some/server/location
2000-0000-xxxx /some/server/location
2000-2001-xxxx /some/server/location
2000-2002-xxxx /some/server/location
2000-2003-xxxx /some/server/location
3000-0000-xxxx /some/server/location
3000-2001-xxxx /some/server/location
3000-2002-xxxx /some/server/location
3000-2003-xxxx /some/server/location

[edit] Source Control

All documents are placed under source control, for security and revision tracking. Use the following procedure to implement source control:

How to place a new file in source control

1. Some steps.

[edit] Comments

I looked at all the convention information I could find, and your initial take on format seems best. IBM is similar, and I know this was one of the conventions in use at DEC. Other popular formats:

  • Beginning (sometimes ending) the name string with the date.
  • Beginning with the intuitive name, numeric sequence following.
  • Some wildly impractical, personal systems

[edit] Comments on Long Documents

The most common advice is "no, don’t do it!" Moving beyond that, consensus seems to be to avoid section breaks at all costs, as they are the most common container for file corruption. Word is known to have file length problems, for which Master Document is the MS cure. But most practitioners feel it is a flawed cure. Suggestions were:

  • Frequent rebuild of the master doc
  • Put no content in the master (except header/footer and TOC)
  • Do all work in sub files (for instance, chapters), build master at end
Retrieved from "http://scratchpad.wikia.com/wiki/0000-0000-naming_conventions_macro_test3"