wize-dev-kit 0.3.0 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +21 -0
- package/ARCH.md +40 -4
- package/CHANGELOG.md +26 -0
- package/README.md +3 -1
- package/package.json +3 -2
- package/src/method-skills/1-analysis/wize-document-project/documentation-requirements.csv +12 -0
- package/src/method-skills/1-analysis/wize-document-project/templates/api-contracts-template.md +38 -0
- package/src/method-skills/1-analysis/wize-document-project/templates/architecture-template.md +54 -0
- package/src/method-skills/1-analysis/wize-document-project/templates/component-inventory-template.md +40 -0
- package/src/method-skills/1-analysis/wize-document-project/templates/contribution-guide-template.md +34 -0
- package/src/method-skills/1-analysis/wize-document-project/templates/data-models-template.md +36 -0
- package/src/method-skills/1-analysis/wize-document-project/templates/deep-dive-template.md +312 -0
- package/src/method-skills/1-analysis/wize-document-project/templates/deployment-guide-template.md +42 -0
- package/src/method-skills/1-analysis/wize-document-project/templates/development-guide-template.md +61 -0
- package/src/method-skills/1-analysis/wize-document-project/templates/index-template.md +185 -0
- package/src/method-skills/1-analysis/wize-document-project/templates/project-overview-template.md +110 -0
- package/src/method-skills/1-analysis/wize-document-project/templates/project-scan-report-schema.json +159 -0
- package/src/method-skills/1-analysis/wize-document-project/templates/source-tree-template.md +142 -0
- package/src/method-skills/1-analysis/wize-document-project/workflow.md +23 -0
- package/src/tea-skills/wize-tea-risk/workflow.md +11 -0
- package/tools/installer/commands/doctor.js +27 -1
- package/tools/installer/commands/document-project.js +93 -0
- package/tools/installer/document-project/batch-scanner.js +93 -0
- package/tools/installer/document-project/classify.js +170 -0
- package/tools/installer/document-project/modes/deep-dive.js +196 -0
- package/tools/installer/document-project/modes/full-rescan.js +15 -0
- package/tools/installer/document-project/modes/initial-scan.js +100 -0
- package/tools/installer/document-project/modes/quick.js +211 -0
- package/tools/installer/document-project/render-index.js +101 -0
- package/tools/installer/document-project/state.js +110 -0
- package/tools/installer/wize-cli.js +46 -30
package/AGENTS.md
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Agents — Wize Development Kit
|
|
2
|
+
|
|
3
|
+
This repo is wired with the [`wize-dev-kit`](https://www.npmjs.com/package/wize-dev-kit).
|
|
4
|
+
Detailed artifacts live under `.wize/`. The agents below are activated through your AI IDE
|
|
5
|
+
using slash commands (Claude Code, Codex, Cursor, Windsurf, Antigravity all read this file).
|
|
6
|
+
|
|
7
|
+
## Roster
|
|
8
|
+
|
|
9
|
+
- **Hawkeye** (`wize-agent-test-architect`) — Test Architect (TEA). |
|
|
10
|
+
- **Wizer** (`wize-orchestrator`) — Orchestrator / Knowledge Base. |
|
|
11
|
+
- **Shuri** (`wize-agent-dev`) — Senior Developer. |
|
|
12
|
+
- **Nick Fury** (`wize-agent-solution-strategist`) — Solution Strategy / Tech Vision. |
|
|
13
|
+
- **Tony Stark** (`wize-agent-architect`) — System Architect. |
|
|
14
|
+
- **Mantis** (`wize-agent-ux-designer`) — UX Designer (Whiteport Design Studio). |
|
|
15
|
+
- **Maria Hill** (`wize-agent-pm`) — Product Manager. |
|
|
16
|
+
- **Peggy Carter** (`wize-agent-tech-writer`) — Technical Writer. |
|
|
17
|
+
- **Pepper Potts** (`wize-agent-analyst`) — Business Analyst (incl. WDS Saga). |
|
|
18
|
+
|
|
19
|
+
## Where to start
|
|
20
|
+
|
|
21
|
+
Activate the orchestrator: `wize-orchestrator` (Wizer). Then ask `/wize-help`.
|
package/ARCH.md
CHANGED
|
@@ -210,7 +210,43 @@ wize-dev-kit sync # regera adapters IDE
|
|
|
210
210
|
|
|
211
211
|
---
|
|
212
212
|
|
|
213
|
-
## 8.
|
|
213
|
+
## 8. Document Project Engine
|
|
214
|
+
|
|
215
|
+
`wize-dev-kit document-project` é a ferramenta de baseline e documentação brownfield do kit.
|
|
216
|
+
|
|
217
|
+
### Modos
|
|
218
|
+
|
|
219
|
+
| Modo | O que faz | Nível de scan |
|
|
220
|
+
|---|---|---|
|
|
221
|
+
| `quick` | Gera 6 arquivos de baseline leves (`overview.md`, `architecture-snapshot.md`, `conventions.md`, `dependencies.md`, `risk-spots.md`, `open-questions.md`). | `quick` apenas |
|
|
222
|
+
| `initial_scan` | Classifica o tipo do projeto, gera `index.md` + docs condicionais conforme o tipo. | `quick`, `deep`, `exhaustive` |
|
|
223
|
+
| `full_rescan` | Arquiva o estado anterior e re-executa `initial_scan` do zero. | `quick`, `deep`, `exhaustive` |
|
|
224
|
+
| `deep_dive` | Análise exaustiva de uma pasta, arquivo, feature, api_group ou component_group. | `exhaustive` |
|
|
225
|
+
|
|
226
|
+
### Arquivo de estado
|
|
227
|
+
|
|
228
|
+
- `.wize/knowledge/document-project/project-scan-report.json` mantém progresso, passos completados e instruções de resume.
|
|
229
|
+
- Arquivos antigos são arquivados em `.wize/knowledge/document-project/_archive/`.
|
|
230
|
+
- `--resume` continua a partir do `current_step`.
|
|
231
|
+
|
|
232
|
+
### Index mestre
|
|
233
|
+
|
|
234
|
+
- `index.md` lista toda a documentação gerada e documentação existente.
|
|
235
|
+
- Docs condicionais que ainda não foram gerados aparecem com `_(To be generated)_`.
|
|
236
|
+
- Re-gerar o index remove os marcadores conforme os arquivos são produzidos.
|
|
237
|
+
|
|
238
|
+
### Componentes de código
|
|
239
|
+
|
|
240
|
+
- `tools/installer/commands/document-project.js` — dispatcher CLI e parsing de args.
|
|
241
|
+
- `tools/installer/document-project/modes/{quick,initial-scan,full-rescan,deep-dive}.js` — implementação dos modos.
|
|
242
|
+
- `tools/installer/document-project/classify.js` — classificador de tipo de projeto via CSV.
|
|
243
|
+
- `tools/installer/document-project/batch-scanner.js` — varredura em batches para evitar estouro de contexto.
|
|
244
|
+
- `tools/installer/document-project/render-index.js` — renderizador do `index.md`.
|
|
245
|
+
- `tools/installer/document-project/state.js` — leitura/escrita do `project-scan-report.json`.
|
|
246
|
+
- `src/method-skills/1-analysis/wize-document-project/templates/` — templates markdown/Handlebars para cada doc condicional.
|
|
247
|
+
- `src/method-skills/1-analysis/wize-document-project/documentation-requirements.csv` — regras de tipo de projeto e flags de scan.
|
|
248
|
+
|
|
249
|
+
## 9. Overlays Web e App
|
|
214
250
|
|
|
215
251
|
### Wize Web Dev (overlay)
|
|
216
252
|
|
|
@@ -228,7 +264,7 @@ wize-dev-kit sync # regera adapters IDE
|
|
|
228
264
|
|
|
229
265
|
---
|
|
230
266
|
|
|
231
|
-
##
|
|
267
|
+
## 10. Agent Builder
|
|
232
268
|
|
|
233
269
|
- 3 skills meta: `wize-create-agent`, `wize-create-skill`, `wize-create-workflow`.
|
|
234
270
|
- Customização de built-ins via `.wize/custom/{tipo}/{code}/customize.toml` (override sem fork).
|
|
@@ -237,7 +273,7 @@ wize-dev-kit sync # regera adapters IDE
|
|
|
237
273
|
|
|
238
274
|
---
|
|
239
275
|
|
|
240
|
-
##
|
|
276
|
+
## 11. Onboarding pós-install (Wizer)
|
|
241
277
|
|
|
242
278
|
1. Wizer triages: greenfield vs brownfield, perfil, objetivo do projeto.
|
|
243
279
|
2. Se brownfield: oferece rodar `wize-document-project` (Tony + Peggy geram baseline).
|
|
@@ -246,7 +282,7 @@ wize-dev-kit sync # regera adapters IDE
|
|
|
246
282
|
|
|
247
283
|
---
|
|
248
284
|
|
|
249
|
-
##
|
|
285
|
+
## 12. Estrutura do repo `wize-dev-kit/` (source code do kit)
|
|
250
286
|
|
|
251
287
|
```
|
|
252
288
|
wize-dev-kit/
|
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,32 @@ Format inspired by [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
|
|
|
5
5
|
|
|
6
6
|
## [Unreleased]
|
|
7
7
|
|
|
8
|
+
## [0.3.1] — 2026-06-13
|
|
9
|
+
|
|
10
|
+
Expands `wize-document-project` from a single lightweight baseline into a multi-mode documentation engine with project-type classification, resume state, and BMAD-equivalent templates.
|
|
11
|
+
|
|
12
|
+
### Added — `wize-document-project` engine
|
|
13
|
+
|
|
14
|
+
- **CLI modes:** `quick`, `initial_scan`, `full_rescan`, `deep_dive` via `wize-dev-kit document-project [mode]`.
|
|
15
|
+
- **Project-type classification:** `documentation-requirements.csv` with 12 types + `classifyProject()` module; detects monolith, multi-part repos, and the kit itself as `cli` + `library`.
|
|
16
|
+
- **JSON state file:** `project-scan-report.json` with schema, init/load/update/archive helpers, and `--resume` support.
|
|
17
|
+
- **Batch scanner:** subfolder-sized scans that skip noise directories and flag files >5000 LOC.
|
|
18
|
+
- **Master index renderer:** `index.md` with links + `_(To be generated)_` markers for missing conditional docs.
|
|
19
|
+
- **Deep-dive mode:** folder, file, feature, `api_group`, `component_group` targets with typed resolution.
|
|
20
|
+
- **11 BMAD-equivalent templates:** index, project-overview, source-tree-analysis, architecture, component-inventory, development-guide, api-contracts, data-models, deployment-guide, contribution-guide, deep-dive.
|
|
21
|
+
|
|
22
|
+
### Added — integration
|
|
23
|
+
|
|
24
|
+
- `doctor` now reports scan-state age, `index.md` "To be generated" marker count, and suggests `document-project` / `wize-refresh-knowledge` when stale.
|
|
25
|
+
- Brownfield installer prompts for documentation mode (quick / initial_scan / full_rescan / skip) with non-TTY fallback to quick.
|
|
26
|
+
- `wize-tea-risk` workflow adds documentation gaps as a risk category.
|
|
27
|
+
- CI smoke E2E now runs `wize-dev-kit document-project quick` and asserts the 6 baseline files.
|
|
28
|
+
- `README.md` and `ARCH.md` updated to describe the new engine and current maturity.
|
|
29
|
+
|
|
30
|
+
### Tests
|
|
31
|
+
|
|
32
|
+
- Total: **219 passing** (was 115).
|
|
33
|
+
|
|
8
34
|
## [0.3.0] — 2026-06-12
|
|
9
35
|
|
|
10
36
|
Adds a single-command diagnostic plus traceable GitHub Releases on every tag.
|
package/README.md
CHANGED
|
@@ -146,6 +146,8 @@ npx wize-dev-kit agent create # scaffold a new custom agent (validated + dry-
|
|
|
146
146
|
npx wize-dev-kit agent edit <code> # override a built-in via .wize/custom/agents/<code>/customize.toml
|
|
147
147
|
npx wize-dev-kit doctor # diagnose kit / project / adapters / gates and suggest fixes
|
|
148
148
|
npx wize-dev-kit validate # structural checks on the kit assets
|
|
149
|
+
npx wize-dev-kit document-project [quick|initial_scan|full_rescan|deep_dive] [--resume] [--target <path>]
|
|
150
|
+
# document the current repo; quick baseline by default
|
|
149
151
|
npx wize-dev-kit uninstall # remove .wize/ (your code is left untouched)
|
|
150
152
|
```
|
|
151
153
|
|
|
@@ -161,7 +163,7 @@ npx wize-dev-kit uninstall # remove .wize/ (your code is left untouched)
|
|
|
161
163
|
|
|
162
164
|
## Status
|
|
163
165
|
|
|
164
|
-
**
|
|
166
|
+
**v0.3.0+ — beta.** The core lifecycle is scaffolded and the `document-project` engine is wired: quick baseline, initial/full/deep scans, project-type classification, resume state, and IDE adapters for Claude Code, Cursor, Windsurf, and others. The CLI commands listed above are executable and tested. Production-readiness target remains v0.5.0.
|
|
165
167
|
|
|
166
168
|
---
|
|
167
169
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json.schemastore.org/package.json",
|
|
3
3
|
"name": "wize-dev-kit",
|
|
4
|
-
"version": "0.3.
|
|
4
|
+
"version": "0.3.1",
|
|
5
5
|
"description": "Full-lifecycle AI-assisted development kit with Test Architect and Whiteport Design Studio embedded. Inspired by BMAD Method and WDS.",
|
|
6
6
|
"keywords": [
|
|
7
7
|
"ai",
|
|
@@ -47,7 +47,8 @@
|
|
|
47
47
|
"CHANGELOG.md",
|
|
48
48
|
"ARCH.md",
|
|
49
49
|
"ROSTER.md",
|
|
50
|
-
"DECISIONS.md"
|
|
50
|
+
"DECISIONS.md",
|
|
51
|
+
"AGENTS.md"
|
|
51
52
|
],
|
|
52
53
|
"dependencies": {
|
|
53
54
|
"prompts": "^2.4.2"
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
project_type_id,requires_api_scan,requires_data_models,requires_state_management,requires_ui_components,requires_deployment_config,key_file_patterns,critical_directories,integration_scan_patterns,test_file_patterns,config_patterns,auth_security_patterns,schema_migration_patterns,entry_point_patterns,shared_code_patterns,monorepo_workspace_patterns,async_event_patterns,ci_cd_patterns,asset_patterns,hardware_interface_patterns,protocol_schema_patterns,localization_patterns,requires_hardware_docs,requires_asset_inventory
|
|
2
|
+
web,true,true,true,true,true,package.json;tsconfig.json;*.config.js;*.config.ts;vite.config.*;webpack.config.*;next.config.*;nuxt.config.*,src/;app/;pages/;components/;api/;lib/;styles/;public/;static/,*client.ts;*service.ts;*api.ts;fetch*.ts;axios*.ts;*http*.ts,*.test.ts;*.spec.ts;*.test.tsx;*.spec.tsx;**/__tests__/**;**/*.test.*;**/*.spec.*,.env*;config/*;*.config.*;.config/;settings/,*auth*.ts;*session*.ts;middleware/auth*;*.guard.ts;*authenticat*;*permission*;guards/,migrations/**;prisma/**;*.prisma;alembic/**;knex/**;*migration*.sql;*migration*.ts,main.ts;index.ts;app.ts;server.ts;_app.tsx;_app.ts;layout.tsx,shared/**;common/**;utils/**;lib/**;helpers/**;@*/**;packages/**,pnpm-workspace.yaml;lerna.json;nx.json;turbo.json;workspace.json;rush.json,*event*.ts;*queue*.ts;*subscriber*.ts;*consumer*.ts;*producer*.ts;*worker*.ts;jobs/**,.github/workflows/**;.gitlab-ci.yml;Jenkinsfile;.circleci/**;azure-pipelines.yml;bitbucket-pipelines.yml;.drone.yml,public/**;static/**;assets/**;images/**;media/**,N/A,*.proto;*.graphql;graphql/**;schema.graphql;*.avro;openapi.*;swagger.*,i18n/**;locales/**;lang/**;translations/**;messages/**;*.po;*.pot,false,false
|
|
3
|
+
mobile,true,true,true,true,true,package.json;pubspec.yaml;Podfile;build.gradle;app.json;capacitor.config.*;ionic.config.json,src/;app/;screens/;components/;services/;models/;assets/;ios/;android/,*client.ts;*service.ts;*api.ts;fetch*.ts;axios*.ts;*http*.ts,*.test.ts;*.test.tsx;*_test.dart;*.test.dart;**/__tests__/**,.env*;config/*;app.json;capacitor.config.*;google-services.json;GoogleService-Info.plist,*auth*.ts;*session*.ts;*authenticat*;*permission*;*biometric*;secure-store*,migrations/**;realm/**;*.realm;watermelondb/**;sqlite/**,main.ts;index.ts;App.tsx;App.ts;main.dart,shared/**;common/**;utils/**;lib/**;components/shared/**;@*/**,pnpm-workspace.yaml;lerna.json;nx.json;turbo.json,*event*.ts;*notification*.ts;*push*.ts;background-fetch*,fastlane/**;.github/workflows/**;.gitlab-ci.yml;bitbucket-pipelines.yml;appcenter-*,assets/**;Resources/**;res/**;*.xcassets;drawable*/;mipmap*/;images/**,N/A,*.proto;graphql/**;*.graphql,i18n/**;locales/**;translations/**;*.strings;*.xml,false,true
|
|
4
|
+
backend,true,true,false,false,true,package.json;requirements.txt;go.mod;Gemfile;pom.xml;build.gradle;Cargo.toml;*.csproj,src/;api/;services/;models/;routes/;controllers/;middleware/;handlers/;repositories/;domain/,*client.ts;*repository.ts;*service.ts;*connector*.ts;*adapter*.ts,*.test.ts;*.spec.ts;*_test.go;test_*.py;*Test.java;*_test.rs,.env*;config/*;*.config.*;application*.yml;application*.yaml;appsettings*.json;settings.py,*auth*.ts;*session*.ts;*authenticat*;*authorization*;middleware/auth*;guards/;*jwt*;*oauth*,migrations/**;alembic/**;flyway/**;liquibase/**;prisma/**;*.prisma;*migration*.sql;*migration*.ts;db/migrate,main.ts;index.ts;server.ts;app.ts;main.go;main.py;Program.cs;__init__.py,shared/**;common/**;utils/**;lib/**;core/**;@*/**;pkg/**,pnpm-workspace.yaml;lerna.json;nx.json;go.work,*event*.ts;*queue*.ts;*subscriber*.ts;*consumer*.ts;*producer*.ts;*worker*.ts;*handler*.ts;jobs/**;workers/**,.github/workflows/**;.gitlab-ci.yml;Jenkinsfile;.circleci/**;azure-pipelines.yml;.drone.yml,N/A,N/A,*.proto;*.graphql;graphql/**;*.avro;*.thrift;openapi.*;swagger.*;schema/**,N/A,false,false
|
|
5
|
+
cli,false,false,false,false,false,package.json;go.mod;Cargo.toml;setup.py;pyproject.toml;*.gemspec,src/;cmd/;cli/;bin/;lib/;commands/,N/A,*.test.ts;*_test.go;test_*.py;*.spec.ts;*_spec.rb,.env*;config/*;*.config.*;.*.rc;.*rc,N/A,N/A,main.ts;index.ts;cli.ts;main.go;main.py;__main__.py;bin/*,shared/**;common/**;utils/**;lib/**;helpers/**,N/A,N/A,.github/workflows/**;.gitlab-ci.yml;goreleaser.yml,N/A,N/A,N/A,N/A,false,false
|
|
6
|
+
library,false,false,false,false,false,package.json;setup.py;Cargo.toml;go.mod;*.gemspec;*.csproj;pom.xml,src/;lib/;dist/;pkg/;build/;target/,N/A,*.test.ts;*_test.go;test_*.py;*.spec.ts;*Test.java;*_test.rs,.*.rc;tsconfig.json;rollup.config.*;vite.config.*;webpack.config.*,N/A,N/A,index.ts;index.js;lib.rs;main.go;__init__.py,src/**;lib/**;core/**,N/A,N/A,.github/workflows/**;.gitlab-ci.yml;.circleci/**,N/A,N/A,N/A,N/A,false,false
|
|
7
|
+
desktop,false,false,true,true,true,package.json;Cargo.toml;*.csproj;CMakeLists.txt;tauri.conf.json;electron-builder.yml;wails.json,src/;app/;components/;main/;renderer/;resources/;assets/;build/,*service.ts;ipc*.ts;*bridge*.ts;*native*.ts;invoke*,*.test.ts;*.spec.ts;*_test.rs;*.spec.tsx,.env*;config/*;*.config.*;app.config.*;forge.config.*;builder.config.*,*auth*.ts;*session*.ts;keychain*;secure-storage*,N/A,main.ts;index.ts;main.js;src-tauri/main.rs;electron.ts,shared/**;common/**;utils/**;lib/**;components/shared/**,N/A,*event*.ts;*ipc*.ts;*message*.ts,.github/workflows/**;.gitlab-ci.yml;.circleci/**,resources/**;assets/**;icons/**;static/**;build/resources,N/A,N/A,i18n/**;locales/**;translations/**;lang/**,false,true
|
|
8
|
+
game,false,false,true,false,false,*.unity;*.godot;*.uproject;package.json;project.godot,Assets/;Scenes/;Scripts/;Prefabs/;Resources/;Content/;Source/;src/;scenes/;scripts/,N/A,*Test.cs;*_test.gd;*Test.cpp;*.test.ts,.env*;config/*;*.ini;settings/;GameSettings/,N/A,N/A,main.gd;Main.cs;GameManager.cs;main.cpp;index.ts,shared/**;common/**;utils/**;Core/**;Framework/**,N/A,N/A,.github/workflows/**;.gitlab-ci.yml,Assets/**;Scenes/**;Prefabs/**;Materials/**;Textures/**;Audio/**;Models/**;*.fbx;*.blend;*.shader;*.hlsl;*.glsl;Shaders/**;VFX/**,N/A,N/A,Localization/**;Languages/**;i18n/**,false,true
|
|
9
|
+
data,false,true,false,false,true,requirements.txt;pyproject.toml;dbt_project.yml;airflow.cfg;setup.py;Pipfile,dags/;pipelines/;models/;transformations/;notebooks/;sql/;etl/;jobs/,N/A,test_*.py;*_test.py;tests/**,.env*;config/*;profiles.yml;dbt_project.yml;airflow.cfg,N/A,migrations/**;dbt/models/**;*.sql;schemas/**,main.py;__init__.py;pipeline.py;dag.py,shared/**;common/**;utils/**;lib/**;helpers/**,N/A,*event*.py;*consumer*.py;*producer*.py;*worker*.py;jobs/**;tasks/**,.github/workflows/**;.gitlab-ci.yml;airflow/dags/**,N/A,N/A,*.proto;*.avro;schemas/**;*.parquet,N/A,false,false
|
|
10
|
+
extension,true,false,true,true,false,manifest.json;package.json;wxt.config.ts,src/;popup/;content/;background/;assets/;components/,*message.ts;*runtime.ts;*storage.ts;*tabs.ts,*.test.ts;*.spec.ts;*.test.tsx,.env*;wxt.config.*;webpack.config.*;vite.config.*,*auth*.ts;*session*.ts;*permission*,N/A,index.ts;popup.ts;background.ts;content.ts,shared/**;common/**;utils/**;lib/**,N/A,*message*.ts;*event*.ts;chrome.runtime*;browser.runtime*,.github/workflows/**,assets/**;icons/**;images/**;static/**,N/A,N/A,_locales/**;locales/**;i18n/**,false,false
|
|
11
|
+
infra,false,false,false,false,true,*.tf;*.tfvars;pulumi.yaml;cdk.json;*.yml;*.yaml;Dockerfile;docker-compose*.yml,terraform/;modules/;k8s/;charts/;playbooks/;roles/;policies/;stacks/,N/A,*_test.go;test_*.py;*_test.tf;*_spec.rb,.env*;*.tfvars;config/*;vars/;group_vars/;host_vars/,N/A,N/A,main.tf;index.ts;__main__.py;playbook.yml,modules/**;shared/**;common/**;lib/**,N/A,N/A,.github/workflows/**;.gitlab-ci.yml;.circleci/**,N/A,N/A,N/A,N/A,false,false
|
|
12
|
+
embedded,false,false,false,false,false,platformio.ini;CMakeLists.txt;*.ino;Makefile;*.ioc;mbed-os.lib,src/;lib/;include/;firmware/;drivers/;hal/;bsp/;components/,N/A,test_*.c;*_test.cpp;*_test.c;tests/**,.env*;config/*;sdkconfig;*.json;settings/,N/A,N/A,main.c;main.cpp;main.ino;app_main.c,lib/**;shared/**;common/**;drivers/**,N/A,N/A,.github/workflows/**;.gitlab-ci.yml,N/A,*.h;*.hpp;drivers/**;hal/**;bsp/**;pinout.*;peripheral*;gpio*;*.fzz;schematics/**,*.proto;mqtt*;coap*;modbus*,N/A,true,false
|
package/src/method-skills/1-analysis/wize-document-project/templates/api-contracts-template.md
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
---
|
|
2
|
+
status: baseline
|
|
3
|
+
owner: Pepper Potts + Tony Stark
|
|
4
|
+
created: {{date}}
|
|
5
|
+
last_refreshed: {{date}}
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# {{project_name}} — API Contracts{{#if part_id}} — {{part_id}}{{/if}}
|
|
9
|
+
|
|
10
|
+
**Date:** {{date}}
|
|
11
|
+
|
|
12
|
+
## Overview
|
|
13
|
+
|
|
14
|
+
{{api_overview}}
|
|
15
|
+
|
|
16
|
+
## Endpoints
|
|
17
|
+
|
|
18
|
+
{{#each endpoints}}
|
|
19
|
+
### {{name}}
|
|
20
|
+
- **Method:** {{method}}
|
|
21
|
+
- **Path:** `{{path}}`
|
|
22
|
+
- **Description:** {{description}}
|
|
23
|
+
|
|
24
|
+
#### Request
|
|
25
|
+
{{request_schema}}
|
|
26
|
+
|
|
27
|
+
#### Response
|
|
28
|
+
{{response_schema}}
|
|
29
|
+
|
|
30
|
+
#### Errors
|
|
31
|
+
{{#each errors}}
|
|
32
|
+
- **{{status}}** — {{description}}
|
|
33
|
+
{{/each}}
|
|
34
|
+
{{/each}}
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
_Generated using Wize Dev Kit `document-project` workflow_
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
---
|
|
2
|
+
status: baseline
|
|
3
|
+
owner: Pepper Potts + Tony Stark
|
|
4
|
+
created: {{date}}
|
|
5
|
+
last_refreshed: {{date}}
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# {{project_name}} — Architecture{{#if part_id}} — {{part_id}}{{/if}}
|
|
9
|
+
|
|
10
|
+
**Date:** {{date}}
|
|
11
|
+
**Type:** {{project_type}}
|
|
12
|
+
**Architecture Pattern:** {{architecture_pattern}}
|
|
13
|
+
|
|
14
|
+
## Executive Summary
|
|
15
|
+
|
|
16
|
+
{{architecture_summary}}
|
|
17
|
+
|
|
18
|
+
## Entry Points
|
|
19
|
+
|
|
20
|
+
{{#each entry_points}}
|
|
21
|
+
- **`{{path}}`** — {{description}}
|
|
22
|
+
{{/each}}
|
|
23
|
+
|
|
24
|
+
## Components
|
|
25
|
+
|
|
26
|
+
{{#each components}}
|
|
27
|
+
### {{name}}
|
|
28
|
+
- **Responsibility:** {{responsibility}}
|
|
29
|
+
- **Location:** `{{location}}`
|
|
30
|
+
- **Depends on:** {{dependencies}}
|
|
31
|
+
- **Used by:** {{dependents}}
|
|
32
|
+
{{/each}}
|
|
33
|
+
|
|
34
|
+
## Data Flow
|
|
35
|
+
|
|
36
|
+
{{data_flow_description}}
|
|
37
|
+
|
|
38
|
+
## Integrations
|
|
39
|
+
|
|
40
|
+
{{#each integrations}}
|
|
41
|
+
- **{{name}}** — {{description}}
|
|
42
|
+
- **Type:** {{integration_type}}
|
|
43
|
+
- **Boundary:** {{boundary}}
|
|
44
|
+
{{/each}}
|
|
45
|
+
|
|
46
|
+
## Decisions & Trade-offs
|
|
47
|
+
|
|
48
|
+
{{#each decisions}}
|
|
49
|
+
- {{description}}
|
|
50
|
+
{{/each}}
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
_Generated using Wize Dev Kit `document-project` workflow_
|
package/src/method-skills/1-analysis/wize-document-project/templates/component-inventory-template.md
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
---
|
|
2
|
+
status: baseline
|
|
3
|
+
owner: Pepper Potts + Mantis
|
|
4
|
+
created: {{date}}
|
|
5
|
+
last_refreshed: {{date}}
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# {{project_name}} — Component Inventory{{#if part_id}} — {{part_id}}{{/if}}
|
|
9
|
+
|
|
10
|
+
**Date:** {{date}}
|
|
11
|
+
**Type:** {{project_type}}
|
|
12
|
+
|
|
13
|
+
## Categorization
|
|
14
|
+
|
|
15
|
+
{{#each categories}}
|
|
16
|
+
### {{name}}
|
|
17
|
+
{{#each components}}
|
|
18
|
+
- **{{name}}** (`{{location}}`) — {{purpose}}
|
|
19
|
+
{{/each}}
|
|
20
|
+
{{/each}}
|
|
21
|
+
|
|
22
|
+
## Reuse
|
|
23
|
+
|
|
24
|
+
{{#each reusable_components}}
|
|
25
|
+
- **{{name}}** — {{usage_guidance}}
|
|
26
|
+
{{/each}}
|
|
27
|
+
|
|
28
|
+
## Design System
|
|
29
|
+
|
|
30
|
+
{{design_system_notes}}
|
|
31
|
+
|
|
32
|
+
## Component Dependencies
|
|
33
|
+
|
|
34
|
+
{{#each dependency_notes}}
|
|
35
|
+
- {{description}}
|
|
36
|
+
{{/each}}
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
_Generated using Wize Dev Kit `document-project` workflow_
|
package/src/method-skills/1-analysis/wize-document-project/templates/contribution-guide-template.md
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
---
|
|
2
|
+
status: baseline
|
|
3
|
+
owner: Peggy Carter + Pepper Potts
|
|
4
|
+
created: {{date}}
|
|
5
|
+
last_refreshed: {{date}}
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# {{project_name}} — Contribution Guide{{#if part_id}} — {{part_id}}{{/if}}
|
|
9
|
+
|
|
10
|
+
**Date:** {{date}}
|
|
11
|
+
|
|
12
|
+
## Local Setup
|
|
13
|
+
|
|
14
|
+
{{local_setup}}
|
|
15
|
+
|
|
16
|
+
## Conventions
|
|
17
|
+
|
|
18
|
+
{{contribution_conventions}}
|
|
19
|
+
|
|
20
|
+
## Pull Request Process
|
|
21
|
+
|
|
22
|
+
{{pr_process}}
|
|
23
|
+
|
|
24
|
+
## Testing
|
|
25
|
+
|
|
26
|
+
{{testing_requirements}}
|
|
27
|
+
|
|
28
|
+
## Questions
|
|
29
|
+
|
|
30
|
+
{{contact_notes}}
|
|
31
|
+
|
|
32
|
+
---
|
|
33
|
+
|
|
34
|
+
_Generated using Wize Dev Kit `document-project` workflow_
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
---
|
|
2
|
+
status: baseline
|
|
3
|
+
owner: Pepper Potts + Tony Stark
|
|
4
|
+
created: {{date}}
|
|
5
|
+
last_refreshed: {{date}}
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# {{project_name}} — Data Models{{#if part_id}} — {{part_id}}{{/if}}
|
|
9
|
+
|
|
10
|
+
**Date:** {{date}}
|
|
11
|
+
|
|
12
|
+
## Overview
|
|
13
|
+
|
|
14
|
+
{{data_model_overview}}
|
|
15
|
+
|
|
16
|
+
## Entities
|
|
17
|
+
|
|
18
|
+
{{#each entities}}
|
|
19
|
+
### {{name}}
|
|
20
|
+
- **Purpose:** {{purpose}}
|
|
21
|
+
- **Source:** `{{source_file}}`
|
|
22
|
+
|
|
23
|
+
#### Fields
|
|
24
|
+
{{#each fields}}
|
|
25
|
+
- `{{name}}` ({{type}}) — {{description}}
|
|
26
|
+
{{/each}}
|
|
27
|
+
|
|
28
|
+
#### Relationships
|
|
29
|
+
{{#each relationships}}
|
|
30
|
+
- {{description}}
|
|
31
|
+
{{/each}}
|
|
32
|
+
{{/each}}
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
_Generated using Wize Dev Kit `document-project` workflow_
|