Add CI Server document map and repo structure #1
7 changed files with 84 additions and 1 deletions
14
.claude/skills/README.md
Normal file
14
.claude/skills/README.md
Normal file
|
|
@ -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:
|
||||
|
||||
```
|
||||
<area>/
|
||||
├── 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.
|
||||
28
CLAUDE.md
Normal file
28
CLAUDE.md
Normal file
|
|
@ -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/<area>/`. 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.
|
||||
26
README.md
26
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/<area>/tasks/<task>.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.
|
||||
|
|
|
|||
4
examples/README.md
Normal file
4
examples/README.md
Normal file
|
|
@ -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.
|
||||
8
knowledge/README.md
Normal file
8
knowledge/README.md
Normal file
|
|
@ -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/<area>/reference/`).
|
||||
|
||||
| File | Contents |
|
||||
|---|---|
|
||||
| `document-map.md` | All EN manuals by IM number, with editions |
|
||||
5
tools/README.md
Normal file
5
tools/README.md
Normal file
|
|
@ -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.
|
||||
Loading…
Add table
Reference in a new issue