Bigsoft output file naming convention

From BigSoft

Jump to: navigation, search

[edit] Why have a naming convention?

During the course of trying to find out the cause of a problem, we may need you to perform certain tasks like a ping or traceroute. We need the output from that command to be sent to us. All these files can get confusing if they don't have a meaningful name. If you ask someone to give it a meaningful name you will end up with 100 files called ping.txt! What's meaningful to one person is unhelpful to another. To this end here at BigSoft we have appointed a naming convention that helps to provide a meaningful structure so there is no confusion.

[edit] File name format

<YYYY-MM-DD>-<command>-<action>.<extension>

The file name is split into 3 sections

  1. Date in reserves numerical form Year-Month-day. For example 2008-12-31 for 31st December 2008
  2. Command: which is the contents of the file i.e. which command has been run e.g. ping
  3. Some specific information relating to the command

Each section is separated by a minus.

[edit] File name examples

Below is a list of examples:

  • 2008-04-30-tracert-work.txt
  • 2008-10-23-outlook-connect-error.jpg
Personal tools