ryanwold.net

A civic-minded citizen seeking the singularity

Back to Entries

On Information Inventories

release
Date: 2017-10-15

As far as modern software developers go, I think I have an above-average appetite for documentation. Not documentation for documentation's sake, but systems are now typically composed of dozens or more objects that have dozens of relationships. Maintaining clarity about this dynamic environment is difficult enough to justify the maintenance and management of an artifact that depicts the visible, public objects in a system.

I noticed that I'd start with list of things. Sketches. Diagrams. Data Models. Annotated wireframes, state diagrams, sequence diagrams. Artifacts that depict that motion of a system; the behavior of a system.

Project Artifacts

  1. Backlog
  2. Code repository
  3. Worklog
  4. Project Calendar
  5. Project Staffing Sheet
  6. Project Scope of Work
  7. Project Kickoff Notes

Product Artifacts

  1. Personas
  2. Content Inventory & Concept Mapping
  3. Wireframes & Page Elements
  4. Data Sources
  5. Branding

Technical Artifacts

  1. What dependencies are required for a project?
    • javascript libraries
    • css libraries
    • databases
    • third-party services
  2. wireframes
  3. flow charts
  4. class diagrams (class, attributes, behaviors, relationships)
  5. graphic assets (images, movies)
  6. code repository (github)
  7. tools (IDE, terminal)

By Ryan Wold · © 2017–2026 Ryan Wold

Licensed CC BY-NC 4.0. AI training requires a license — machine-readable terms.

Enjoyed this? — any BSV wallet, HandCash, or plain old dollars.

Leave a tip

Tips go directly to a Bitcoin SV address I control — peer to peer, no platform in between. A few thousand satoshis is a fraction of a cent; it's the gesture that counts.

From any BSV wallet

Scan the QR code with your wallet's camera, or copy the address.

177DwUfSTW8RkFBJzYYcgr1YB8ngbhTYAc

With HandCash or any paymail wallet

Paymail is an email-style address for Bitcoin wallets. Send any amount to afomi@handcash.io

First time using Bitcoin? Yours Wallet is an open-source browser extension wallet, and HandCash is an easy mobile wallet — either takes a minute to set up.

Prefer regular money? Support via OpenCollective.