Skip to main content

How to Navigate

Let's take a look around, shall we?

Main Directories​

On the left, you'll see the four main directories that follow. Together, the four are designed to encompass every type of documentation our company might create. Any material we compile should fall under one of the following:

  • Company - information about our company policies and resources
  • Software Development - information on or compiled by/for the Software Development team
  • Data Analytics - information on or compiled by/for the Data Analytics team
  • Deprecated - old and possibly unneeded information, mostly kept for reference or updating

Generally speaking, our docs site directory strucure should follow the standard of:

  • Directory Landing
    index page describing what the directory is and what it contains

  • Sub Directory Landing
    sub sections that fall under the main header, with a similar index page explaining what's contained in the directory
    (there can be multiple layers of sub directories)

  • Documentation File
    actual file containing compiled information of typebest practices, research records, process explanation, etc.

Last updated on by Zach Sedlack