Table of Contents
Introduction¶
This guideline defines the naming conventions used for ERP5 documentation and documents related to Nexedi stack in general. Defining a naming convention for documentation or for corporate documents may seem awkward. However, as soon as a group of people work on the same set of documents within a company, within a community or accross communities and companies, they start exchanging documents. It is quite frequent to see engineers exchanging documents named "Untitled-3.doc" or "Offer.xlsx" and wondering after some time what was this document, in which version and where was the translated version in a certain language.
By defining very precisely and once for all how all documents should be named, this common problem can be solved no matter which document management system everyone uses and no matter how documents have been shared: by email, through the Web, using a real time collaboration editor.
We will define below the general ideas that should be adopted for ERP5 documentation with some examples. Afterwards we will provide a precise reference of rules to follow, recommendations and crimes with patterns to avoid.
General Principles¶
All documents should be named according to the following principle:
- First a Reference representing the project (ex. P-JIO), group or publication section a document is related to.
- Then a Document Name (ex. Design.Document) which represents a document name or title.
- Then a Version number (ex. 001) (added automatically)
- Then a Language (ex. en) (added automatically)
- And at the end an Extension in relation with the MIME type (ex. .odt) (added automatically)
Examples:
- P-BAOBAB-Design.Document-001-en.odt
- NXD-Operation.Rules-001-en.odt
- erp5-solution-overview-001-en.html
${predicate_view_as_book}