Skip to content

Datasheets, Certifications & IOM

The datasheets, certifications, installation and operation manuals (IOM) are to be kept in @docs folder in SharePoint following proper naming convention. It is important to follow the naming convention because the file names will become PDF bookmarks and table of contents when they are combined using bid cli (command line tool).

File Naming Convention

The naming convention is:

Acronym + Brand + Model + Description + Remark(Optional)

For example:

  • DS Cobham Sailor 250 FleetBroadBand.pdf
  • DS Cobham Sailor 6222 VHF DSC Class A - Obsolete.pdf
  • DS Cobham Sailor SP3540 VHF GMDSS ATEX Portable Radio.pdf

The purpose is to be able to easily identify at a glace. The file name should be as informative as possible but not bloated. For the Font, Title Case is preferred. Remark is used to add additional information, such as item's obsolescence, expiry date for certificate etc. For the date, ISO Date format of yyyy-mm-dd is to be used. For TD and TQ, the naming convention may not be directly applicable. In these cases, give concise and descriptive title.

Acronyms

  • BR: Brochure
  • CERT: Certificate
  • DR: Drawing
  • DS: Datasheet
  • IOM: Installation and Operation Manual
  • PR: Project Reference
  • PIC: Picture or Photograph
  • PTT: Presentation
  • REG: Regulation
  • TD: Technical Description
  • TQ: Technical Query. These are any technical note that one should be aware of.

Precise acronyms are important so that one can know the type of document at a glance. At the same time, these are intentionally ignored in PDF outline so that they do not clutter.

Before saving a particular file, it is recommended to highlight particular models, keywords, etc. so that the recipient knows exactly what model is chosen. For the datasheet that contains multiple models, many versions of that particular file highlighting each model number should be saved with relevant names.

@docs should not contain any price sensitive information, as files in here are meant to be shared with clients and may be with other teams down the road.

New Acronyms can be recommended and we will put it into specification once accepted based on mutual consent.