Repository alpha5

About

The utility repo-alpha5 installs a collection of directories based on the alpha5 specification.

The alpha5 specification is a standard towards setting a standard working directory structure within containers, such as boxxd, so that people have a guide where to save files that serve a specific function. Having a standard facilitates the exchange of data and the building of automation processes.

The name alpha5 is the short form for ABCDE - The abbreviation for A Basic Container Directory Extension.

alpha5 has been laid out for human use and has a very basic structure:

• Archive for backups and archiving
• Items for things which can be used i.e. finished being worked on
• Sources for things which are being created and are being worked on
• Works for the complimentary documents which are needed to support the processes i.e. daily work

The directories are described in more detail below.

The directories in detail

Out of the boxxd user perspective, in alphabetical order.

Archive directory

This directory serves as a place in which you can dump files for that “just in case” moment in the future.

Items directory

This directory is is where the finished project assets are kept - i.e. the files that you will be using with customers or other 3rd parties, such as PDFs, jpgs, mp4.

Things that are being created and edited such as doc, cad, svg, software sources, are to be placed in the Sources directory.

Within this directory users can create directories for each bundle of objects which are being creating i.e. flyers, advertisements, website, thing-xyz, so that they can be navigated easily.

Sources directory

This directory is for the project assets sources - i.e. the files that are being created to build what ever you are wanting to do.

Finished things such as customer PDFs, website are to be placed in the Items directory.

Examples

• Book Project: The book manuscript, the artwork files for the book, posters, flyers, etc.
• House Building Project: Working CAD files, artwork for flyers, image working files.
• Software Project: The source files for the components, the website, the artwork files for graphics, for flyers.

Works directory

This directory is for your “work” that accompanies your project such as marketing lists, purchasing, planning, cost calculations, design specifications.

Things that are being created or being built i.e. the main project assets, are to be placed in the Sources or Items directories.

Examples

Examples of how you could use the Works directory:

• Marketing: You would create a subdirectory called “Marketing” and you would have your list of advertisers, marketing plan, etc. there.
• Design: You would create a subdirectory called “Design” and you would place your style specification, 3rd party correspondence there.
• Legal: You would create a subdirectory called “Legal” and place all relevant documents that are needed for the project there.

Tips

• Have a look at the Value Domain Stack plugin - It offers a collection of standard names which can be used internally and with 3rd parties. It also has the advantage for small teams of giving an insight into other processes and therefore saving time and creating value.