Unified Style Guide - Syntax Brainstorming

The Unified Style Guide (aka USG) is a side project I've been slowly piecing together over the past few years. It started mainly as an effort to document my personal preferences for structuring files and folders. A special file reserved in the style guide is the directory information file which simply provides a plain text description of the directory contents. When necessary, I have been using these files to describe the naming convention of the …

more ...

Introducing The Unified Style Guide

Style guides are an important part of the software development process. They keep code consistent across projects and help maintain a level of cleanliness and professionalism. A few years ago, I realized there were no (to my knowledge) guides for general file and directory naming so I started one. Over time, I gradually updated it and eventually named it the Unified Style Guide with the lofty goal of one day expanding it to programming languages …

more ...

Directory Information Please

Sometimes a directory structure needs a little extra information. Even the most well thought-out directory names lack the expressiveness of a few short remarks. My solution for these cases has been to add a file named __dir_info__.txt to a directory requiring additional details. This file provides an explanation of the directory's purpose, which typically starts with This directory contains ..., and is formatted using AsciiDoc.

Let's look at an example:

= foobar
:date: 5 January 2015 …
more ...

Hi, I am Jeff Rimko!
A computer engineer and software developer in the greater Pittsburgh, Pennsylvania area.