From a1471208db2bc90aa78f3577a5ec6afb1f38ecde Mon Sep 17 00:00:00 2001 From: cliu Date: Tue, 29 Sep 2026 18:23:31 +1000 Subject: [PATCH] Set up repo structure for CI Server engineering assistant Add CLAUDE.md with role, target version (R1.03) and lookup order, and top-level folders for skills, shared knowledge, examples and tools. Move the document map to knowledge/ and rewrite the README. Co-Authored-By: Claude Opus 5.5 --- .claude/skills/README.md | 14 ++++++++++ CLAUDE.md | 28 +++++++++++++++++++ README.md | 26 ++++++++++++++++- examples/README.md | 4 +++ knowledge/README.md | 8 ++++++ .../document-map.md | 0 tools/README.md | 5 ++++ 7 files changed, 84 insertions(+), 1 deletion(-) create mode 100644 .claude/skills/README.md create mode 100644 CLAUDE.md create mode 100644 examples/README.md create mode 100644 knowledge/README.md rename docs/ci-server-document-map.md => knowledge/document-map.md (100%) create mode 100644 tools/README.md diff --git a/.claude/skills/README.md b/.claude/skills/README.md new file mode 100644 index 0000000..fe5f4f9 --- /dev/null +++ b/.claude/skills/README.md @@ -0,0 +1,14 @@ +# Skills + +One skill per CI Server area, following `knowledge/document-map.md`. Nested skill folders +are not used for grouping; group tasks inside each skill instead: + +``` +/ +├── SKILL.md # frontmatter (name, description with task keywords) + task index +├── tasks/ # one file per task +└── reference/ # area-specific details +``` + +The `description` in `SKILL.md` decides when Claude uses the skill. List the words users +will actually say. diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..8556ea5 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,28 @@ +# CI Server Engineering Assistant + +You act as an experienced Yokogawa CI Server engineer. Users describe what they want to do +in CI Server; you do it (or guide them) using the knowledge in this repo. + +- **Target version:** CI Server **R1.03**. Say so if a request depends on another release. +- **Language:** use the English (EN) manuals only. + +## Where to look, in order + +1. **Skills**: `.claude/skills//`. There is one skill per CI Server area (e.g. Edit Module, + Alarm Management). `SKILL.md` is an index; open only the task file you need. +2. **Shared knowledge**: `knowledge/`. The document map, glossary, known issues and + system-wide concepts. +3. **Examples**: `examples/`. Verified, working artifacts to copy and adapt. +4. **The manuals**: if the repo does not cover it, look it up in the EN PDFs. They are **not** + in this repo. Default location: `C:\Users\Public\Yokogawa\tls\doc\EN\`. Use + `knowledge/document-map.md` to find the right manual by IM number. + +If the answer comes from the manuals rather than the repo, say so and name the manual +(IM number and section). Never guess CI Server behavior; say what you could not verify. + +## Conventions + +- Summarize manual content in your own words; never copy manual text into the repo. +- Cite sources (IM number + section) and the version in every knowledge or task file. +- Mark whether content is **verified** on a real system or **from docs** only. +- Never modify the manual folder. diff --git a/README.md b/README.md index dd42dcd..1f79c12 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,27 @@ # ci-server-config -Configuration for the CI server. +A knowledge base that lets Claude Code work as a Yokogawa CI Server (R1.03) engineer. +Open this repo in Claude Code and describe what you want to do in CI Server. + +## Layout + +| Path | Contents | +|---|---| +| `CLAUDE.md` | Always-loaded instructions: role, version, where to look | +| `.claude/skills/` | **How to do things.** One skill per CI Server area; each task is its own file | +| `knowledge/` | **Shared reference.** Document map, glossary, known issues, cross-area concepts | +| `examples/` | Verified, working artifacts (class descriptions, reports, scripts) | +| `tools/` | Helper scripts Claude can run (e.g. searching the manuals) | + +## Prerequisites + +The CI Server EN manuals must be available locally. They are not stored in this repo. +The default location is `C:\Users\Public\Yokogawa\tls\doc\EN\`; see +`knowledge/document-map.md` if yours is different. + +## Contributing + +- Add task knowledge under the matching skill: `.claude/skills//tasks/.md`, + and add a row to that skill's `SKILL.md` index. +- Write in your own words, cite the manual (IM number + section) and the version, and mark + the content as verified or from docs. diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..93405c0 --- /dev/null +++ b/examples/README.md @@ -0,0 +1,4 @@ +# Examples + +Working artifacts Claude can copy and adapt. Only add content that has been tested on a +real CI Server system; note the version and where it was tested. diff --git a/knowledge/README.md b/knowledge/README.md new file mode 100644 index 0000000..7cb08b0 --- /dev/null +++ b/knowledge/README.md @@ -0,0 +1,8 @@ +# Knowledge + +Reference content that applies across CI Server areas. Details for one area belong in +that area's skill (`.claude/skills//reference/`). + +| File | Contents | +|---|---| +| `document-map.md` | All EN manuals by IM number, with editions | diff --git a/docs/ci-server-document-map.md b/knowledge/document-map.md similarity index 100% rename from docs/ci-server-document-map.md rename to knowledge/document-map.md diff --git a/tools/README.md b/tools/README.md new file mode 100644 index 0000000..7d055c5 --- /dev/null +++ b/tools/README.md @@ -0,0 +1,5 @@ +# Tools + +Helper scripts Claude can run. Scripts that read the manuals must not hard-code their +location; take it from an argument or environment variable, with +`C:\Users\Public\Yokogawa\tls\doc\EN\` as the default.