085400100001 Programming standard Nomenclature

Programming standard

This programming standard can apply to any language, it will have example mostly in powershell and csharp.

Document managing
Nomenclature / Managing documents for this blog

Let's use 3 digit for identifying stuff. All from 000 to zzz (case being not important)

The first 3 digit is the client identification. Numbers and alphanumeric, from 000 to zzz

The client being myself, let's say I am number 085 (wildboy85 being my easily identifiable internet nickname)

085 Clave 

Will be the client name (the name clave come from, a cloud in a cave, meaning my cloud is in a basement)

400 TIC_Informatique

Will be the main sector number for TIC (information technology and communication)

100 Programming

The sub sector will be programming

001 Programming standard

Project number and name, sequential, so 001 is the number for "programming standard" project


001 Nomenclature

Numerotation, names. Made so we can find and replace easily. Also eays to refer to. Also have an order of things.

002 Requis

Requirements of the program. Do you need a database? A special module? A library from somewhere?

003 Documentation

Documents about the program (no, it will not be at the end, and be forgotten :P)

004 Analysis

This is a phase of the project

005 IO

Inputs output design, what go in, processing and what goes out
What screens are the inputs, wich fields? What reports or screens are the outputs?

006 Database diagram

How many tables? What are the relations? What are the keys? What are the restraints?

007 Processing diagram

Drawing of the input, output and processing. At the macro level (1) or more detailed. (up to 10)

Note: doing a diagram level 10 is the same thing as programming the whole program visually

008 Database diagram

So, the id:

085400100001005 will be:

Company:

085 Clave

The sector, computer science (informatique):

400 TIC_Informatique

The sub sector, programmation

100 Programming

The project, establising a programming standard:

001 Project about programming standard

The first phase of the project, the analysis:

004 Analysis

etc.

This nomenclature will allow us to find any section with a simple search very fast

It will also allow to easy referencing

It will allow us to identify a document with an id that have a meaning