Skip to content

Latest commit

 

History

205 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

standards

Public standards, reusable shell components, prompt guidance, and operator-style conventions for my local tools, helper applications, dotfiles, security workflows, publication workflows, and project ecosystems.

This repository can look like a collection of shell and repository style guides at first glance.

It is broader than that.

It is a codified operational architecture for documenting, reviewing, publishing, and maintaining technical systems with both human and AI operators in mind.

This repository exists to:

  • show how I think and work
  • keep projects visually and operationally consistent
  • define reusable shell components
  • define script, documentation, commit, prompt, and directory-structure standards
  • define operational safety rules for shell scripts, helper tools, and automation
  • define publication, audit, and OPSEC review practices
  • give AI coding tools a canonical source for applying my style
  • maintain a cohesive view of my projects and operating patterns

Philosophy

I impose structure on systems so they are immediately navigable, maintainable, and operable by humans and by machines.

If you drop me into any system, I will determine where everything is, where it should be, and how to organize it so teams do not get lost.

The goal is not rigid structure for its own sake.

The goal is eliminating ambiguity.

What this repo contains

  • shell style standards
  • shell component architecture
  • cross-language code style standards
  • graphical script header standards
  • script content and comment standards
  • destructive-action safety standards for shell scripts and helper applications
  • comment and description conventions
  • reusable shell components
  • selector/menu conventions
  • loader and terminal text-effect conventions
  • color definitions and palette pairings
  • typography and PDF-oriented output standards
  • commit message standards
  • filesystem and project-structure standards
  • multi-node secure systems repository standards
  • shell prompt standards
  • AI prompt guidance for applying these standards
  • repository audit and refactor guidance
  • repository taxonomy
  • README and GitHub Pages documentation standards
  • media asset publication workflow
  • OPSEC methodology
  • publication audit prompts
  • operational standards authority for other projects
  • examples and reusable patterns

These pieces are meant to connect:

taxonomy
    ->
workflow standards
    ->
naming conventions
    ->
publication pipelines
    ->
OPSEC methodology
    ->
audit prompts
    ->
AI-operational prompts
    ->
repository publication systems

Most repositories stop at one layer: a style guide, a naming convention, a prompt snippet, an OPSEC checklist, or documentation advice.

This repository connects those layers into a repeatable operating system.

It documents how systems should be documented, reviewed, operationalized, and safely published.

Operational standards authority

This repo is not just documentation.

It is a reusable operational standards authority.

It defines safety guardrails for local automation: old executable scripts are treated as untrusted until reviewed, no-argument execution should be safe, and destructive actions should require explicit operator intent through dry-run / apply patterns or similarly clear controls.

That means:

  • humans can read it
  • AI coding tools can consume it
  • future repos can reference it
  • reusable shell components can be imported from it
  • audits and refactors can be standardized against it
  • project-structure decisions have a canonical source

In practice, this repo functions as personal engineering standards infrastructure.

This level of centralized engineering standards infrastructure is more commonly found in mature engineering organizations with dedicated platform, tooling, or developer-experience functions.

This repository applies the same operational thinking at an individual scale.

See differentiator.md for why this repository matters as a public portfolio artifact.

For concrete examples of the operating architecture, see:

Repository OPSEC prompt architecture

The repository OPSEC workflow is intentionally ordered instead of hidden inside one large all-purpose prompt.

The prompt filenames use numeric prefixes so the sequence is visible in terminal output, editor sidebars, and GitHub file listings:

repository-opsec-01-initiate.md
repository-opsec-02-audit.md
repository-opsec-03-remediate-text.md
repository-opsec-04-remediate-media.md

That ordering makes the workflow clean and coherent to both humans and machines.

The architecture separates three responsibilities:

  • initiation establishes the publication context and operating constraints
  • audit inspects the repository and produces a report only
  • remediation happens later through approved, scoped follow-up prompts

The audit phase does not mutate files.

It does not redact, rewrite, delete, move, rename, commit, publish, or otherwise repair anything automatically.

Remediation requires a separate human-approved instruction with clear scope.

This avoids:

  • silent mutation
  • review bypass
  • one giant magic prompt behavior
  • ambiguity about whether the AI has authority to change the repository

The point is not to claim operational maturity.

The workflow demonstrates it: discovery, assessment, approval, and repair are separate phases with visible boundaries.

Project initialization

Use prompts/project-initialization.md as the entrypoint for new projects, repository work, Codex sessions, and ChatGPT coding threads.

For local work, use docs/visible-terminal-workflow.md as the default: run chatgpt from the target repository root, tell ChatGPT the session name, and load standards through that visible shell. The copied initialization prompt is retained for remote, disconnected, and standalone agent sessions.

That prompt locates the standards repository, reads the relevant standards cascade, and establishes the operating rules before edits begin.

Directory structure

standards/
├── README.md
├── bin/
├── docs/
├── prompts/
├── shell/
├── directory_structures/
├── pages/
├── examples/
└── assets/

Directory meanings

docs/
    written standards, rationale, conventions, and human-readable authority

bin/
    executable standards tools, including install and sync helpers for
    consumer repositories

prompts/
    AI-facing prompt material that tells assistants how to apply the standards

shell/
    reusable implementation components, helpers, loaders, colors, headers,
    terminal text helpers, interactive and numbered selectors, and text effects

directory_structures/
    starting structures, project skeletons, and reusable filesystem layouts

pages/
    reusable GitHub Pages documentation-site standards and implementation kit

examples/
    working examples that demonstrate the standards in practice

assets/
    visual reference assets such as ANSI art, ASCII art, screenshots, palette
    references, typography fixtures, and other supporting media

The docs/ directory is the canonical authority for written standards. The prompts/ directory should point AI tools at those standards and explain how to apply them. The shell/ directory contains reusable implementation pieces. The directory_structures/ directory contains example or starter filesystem layouts that can be copied, adapted, or used as references.

assets/typography/ contains reusable chat and document rendering fixtures for Markdown-to-HTML/PDF workflows.

Current populated areas

docs/
    core written standards

bin/
    standards installation and sync tooling

prompts/
    AI prompt standards and publication-audit workflows

shell/
    initial reusable shell component stubs

directory_structures/
    starter structures and reusable layouts for common project types

assets/
    typography fixtures and visual reference assets

The examples/ directory is intentionally present as a planned expansion area.

AI handoff workflows

This repository includes reusable handoff workflows for AI-assisted development.

The workflows are designed for local Codex sessions, ChatGPT review, and operator-controlled commits:

Codex loads project standards.
Codex asks whether to use HITL review packets, transcript handoff, or neither.
Codex makes scoped edits.
Codex follows the selected handoff workflow when a review artifact is needed.
The operator pastes the artifact into ChatGPT or another review channel.
The operator and reviewer inspect the same context or evidence.
The operator explicitly approves revision, discard, or commit.

This keeps AI useful for implementation while preserving human control over repository state, privacy boundaries, validation evidence, and commit decisions.

Clipboard review packets must use the verbatim final operator-visible assistant response for the final-response payload, including visible list and multiline block structure. They must not substitute an internal summary or rewritten note.

Transcript handoffs are the lighter option for routine iterative work. They copy only the most recent operator prompt and terminal-visible assistant output verbatim, without adding review-packet sections, summaries, validation headings, checks, git status, or diffs.

The specialized prompts for these workflows are:

prompts/hitl-review-packet.md
prompts/transcript-handoff.md

The project initialization prompt advertises these as optional session workflows and supports session preference checks with:

show session preferences

Core principle

A well-structured system should not require explanation.

If explanation is required, the structure is part of the problem.

About

Public standards, reusable shell components, prompt guidance, and operator-style conventions for my tools, dotfiles, automation workflows, and project ecosystems.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Contributors

Languages