Back to the catalog

Workaholic Knowledge Base

Bundle OKF 0.1 · 8 conceitos · qmu/research

Open source Repository Open in the app JSON README (API)

About

# Workaholic Knowledge Base

The development knowledge this project's workaholic workflows generate and maintain,
organized as an Open Knowledge Format bundle. Enter any area through its index.

* [tickets/](tickets/) - implementation tickets (two states: todo / archive; the outcome is the status: field)
* [housekeeping/](housekeeping/) - the /housekeep tick log, one file per UTC day (an operational log, not knowledge: no type:, no index)
* [stories](stories/index.md) - branch development narratives (PR descriptions and historical record)
* [missions](missions/index.md) - optional epic-equivalent batches of tickets, with acceptance progress and an append-only changelog
* [feedbacks](feedbacks/index.md) - the inbound feedback stream: immutable records of insights, instructions, concerns, and customer material
* [deployments](deployments/index.md) - deployment targets and confirmation methods
* [release-notes](release-notes/index.md) - per-branch release notes, one per shipped unit
* [tr

Details

Kind
OKF bundles
Topic
AI, RAG & memory
Publisher
qmu
Origin
okf_github
Category
dados
Version
0.1
Open pull requests
5
Last push
2026-09-08T15:06:01Z
Repository state
ativo
Language
TypeScript
License
MIT
Added
2026-09-08 22:08:51
Updated
2026-09-08 22:08:51
Origin id
qmu/research:.workaholic/index.md

README

# research

Public, reproducible foundational research for [qmu.co.jp](https://qmu.co.jp).

This repository holds qmu's fundamental technical and industry research — LLM
benchmarks, architectural studies (for example multi-tenant multi-database
models), and market research. Each research topic ships as runnable code so a
reader can clone this repository and reproduce the result for themselves. Result
pages are written as Markdown, previewed locally, and published to the corporate
site as foundational research.

## Repository layout

The top level is divided by role:

| Directory     | Role                                                                 |
| ------------- | -------------------------------------------------------------------- |
| `packages/`   | Research code. `packages/tech/` and `packages/industry/` are each a single npm project; individual researches live as subfolders inside. |
| `scripts/`    | Repository-wide scripts (verb-named, e.g. `publish-research.sh`).    |
| `workloads/`  | Execution environment and infrastructure config (`workloads/docker/`). |
| `databases/`  | Database schemas and migrations, one subdirectory per database.      |
| `docs/`       | Documentation: the preview site, research reports, ADRs, the glossary, and the dependency-decision log. |
| `outputs/`    | Runtime output (gitignored).                                         |

## Commands

All common operations run through `make`. Run `make help` for the list.

| Command         | Effect                                                        |
| --------------- | ------------------------------------------------------------- |
| `make install`  | Install dependencies in every package.                        |
| `make build`    | Type-check and build every package.                           |
| `make test`     | Type-check and run unit tests in every package.               |
| `make lint`     | Lint and format-check every package.                          |
| `make format`   | Apply formatting across every package.                        |
| `make docs`     | Run the local research preview site (VitePress).              |
| `make publish`  | Copy finished research Markdown to the corporate site.        |

Continuous integration invokes these same commands, so what runs in CI is what
you can run locally.

## Reproduce a research

```sh
git clone <this repo>
cd research
make install
# then run a specific research, e.g.:
cd packages/tech && npm run dev
```

Each research topic documents its exact commands, required credentials, and
expected cost in its own README and result page.

## Requirements

- Node.js 22 (see `.nvmrc`)
- `make`
- Docker (optional, for `workloads/docker/` reproducible environments)

## License

[MIT](LICENSE).

More