Compare commits
No commits in common. "a1471208db2bc90aa78f3577a5ec6afb1f38ecde" and "a5c8176a6f00c9891f393fa4572ff4ea816bf788" have entirely different histories.
a1471208db
...
a5c8176a6f
7 changed files with 1 additions and 198 deletions
|
|
@ -1,14 +0,0 @@
|
|||
# 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
28
CLAUDE.md
|
|
@ -1,28 +0,0 @@
|
|||
# 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,27 +1,3 @@
|
|||
# ci-server-config
|
||||
|
||||
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.
|
||||
Configuration for the CI server.
|
||||
|
|
|
|||
|
|
@ -1,4 +0,0 @@
|
|||
# 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.
|
||||
|
|
@ -1,8 +0,0 @@
|
|||
# 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 |
|
||||
|
|
@ -1,114 +0,0 @@
|
|||
# CI Server Document Map (EN)
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
| **Software** | Yokogawa CI Server **R1.03** (R1.03.00 or later) |
|
||||
| **Documentation set** | English manuals, editions dated Sep. 2023 (see Edition column) |
|
||||
| **Source** | `ciserver.pdf` (English page) in the documentation folder |
|
||||
|
||||
> [!IMPORTANT]
|
||||
> **Documentation location is machine-specific.**
|
||||
> The links below point to the default location on the machine where this map was written:
|
||||
> `C:\Users\Public\Yokogawa\tls\doc\EN\`
|
||||
>
|
||||
> The PDFs are **not** stored in this repository. If your CI Server documentation is installed
|
||||
> elsewhere, the links will not open. Look up the manual by its **IM number / file name**
|
||||
> (e.g. `IM36K01C10-01EN.pdf`) in your own `...\doc\EN\` folder, or find-and-replace
|
||||
> `file:///C:/Users/Public/Yokogawa/tls/doc/EN/` in this file with your local path.
|
||||
>
|
||||
> If your installed CI Server release is not R1.03, check that your manual editions match the ones listed here.
|
||||
|
||||
## Read Me First
|
||||
|
||||
| Document | IM Number | Edition |
|
||||
|---|---|---|
|
||||
| [Read Me First](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K01A10-01EN.pdf) | IM 36K01A10-01EN | 2nd Edition, Sep. 2023 |
|
||||
| [CI Server Release Information](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K01A50-01EN.pdf) | IM 36K01A50-01EN | 3rd Edition, Sep. 2023 |
|
||||
|
||||
## Installation
|
||||
|
||||
| Document | IM Number | Edition |
|
||||
|---|---|---|
|
||||
| [CI Server Setup](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K01C10-01EN.pdf) | IM 36K01C10-01EN | 3rd Edition, Sep. 2023 |
|
||||
| [CI Server Security Guide](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K01C30-01EN.pdf) | IM 36K01C30-01EN | 3rd Edition, Sep. 2023 |
|
||||
|
||||
## User Manual
|
||||
|
||||
### Engineering Basics
|
||||
|
||||
| Document | IM Number | Edition |
|
||||
|---|---|---|
|
||||
| [Engineering Module - I/O Processes](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10C10-01EN.pdf) | IM 36K10C10-01EN | 3rd Edition, Sep. 2023 |
|
||||
| [Engineering Module - Alarms](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10C20-01EN.pdf) | IM 36K10C20-01EN | 3rd Edition, Sep. 2023 |
|
||||
| [Engineering Module - Reporting](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10C30-01EN.pdf) | IM 36K10C30-01EN | 3rd Edition, Sep. 2023 |
|
||||
| [Engineering Module - Historical](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10C40-01EN.pdf) | IM 36K10C40-01EN | 3rd Edition, Sep. 2023 |
|
||||
| [Edit Module](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10C50-01EN.pdf) | IM 36K10C50-01EN | 3rd Edition, Sep. 2023 |
|
||||
| [Advanced Operating Graphics](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10C60-01EN.pdf) | IM 36K10C60-01EN | 3rd Edition, Sep. 2023 |
|
||||
|
||||
### Function
|
||||
|
||||
| Document | IM Number | Edition |
|
||||
|---|---|---|
|
||||
| [Excel Add-in Data Analysis and Reporting](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10E10-01EN.pdf) | IM 36K10E10-01EN | 3rd Edition, Sep. 2023 |
|
||||
| [OPC Interface](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10E20-01EN.pdf) | IM 36K10E20-01EN | 2nd Edition, Sep. 2023 |
|
||||
| [Alarm System Performance Analysis](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10E30-01EN.pdf) | IM 36K10E30-01EN | 3rd Edition, Sep. 2023 |
|
||||
|
||||
## Tutorial
|
||||
|
||||
| Document | IM Number | Edition |
|
||||
|---|---|---|
|
||||
| [CI Server Tutorial](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10G10-01EN.pdf) | IM 36K10G10-01EN | 3rd Edition, Sep. 2023 |
|
||||
|
||||
## Engineering Manual
|
||||
|
||||
### System Design / System Construction
|
||||
|
||||
| Document | IM Number | Edition |
|
||||
|---|---|---|
|
||||
| [CI Server System Design/Management](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10J10-01EN.pdf) | IM 36K10J10-01EN | 3rd Edition, Sep. 2023 |
|
||||
| [High Availability Computing](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10J20-01EN.pdf) | IM 36K10J20-01EN | 3rd Edition, Sep. 2023 |
|
||||
| [Active Directory Integration](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10J40-01EN.pdf) | IM 36K10J40-01EN | 3rd Edition, Sep. 2023 |
|
||||
|
||||
### Function
|
||||
|
||||
| Document | IM Number | Edition |
|
||||
|---|---|---|
|
||||
| [Class/Object Engineering](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10L10-01EN.pdf) | IM 36K10L10-01EN | 3rd Edition, Sep. 2023 |
|
||||
| [Alarm Management Engineering](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10L15-01EN.pdf) | IM 36K10L15-01EN | 3rd Edition, Sep. 2023 |
|
||||
| [History Management Engineering](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10L20-01EN.pdf) | IM 36K10L20-01EN | 3rd Edition, Sep. 2022 |
|
||||
| [Audit Trail Management Engineering](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10L25-01EN.pdf) | IM 36K10L25-01EN | 3rd Edition, Sep. 2023 |
|
||||
| [BUS Service Engineering](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10L30-01EN.pdf) | IM 36K10L30-01EN | 3rd Edition, Sep. 2023 |
|
||||
| [ITEM Service Engineering - ITH](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10L35-01EN.pdf) | IM 36K10L35-01EN | 3rd Edition, Sep. 2023 |
|
||||
| [ITEM Service Engineering - ITM](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10L36-01EN.pdf) | IM 36K10L36-01EN | 3rd Edition, Sep. 2023 |
|
||||
| [EQUIPMENT Service Engineering - Utilities](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10L40-01EN.pdf) | IM 36K10L40-01EN | 3rd Edition, Sep. 2023 |
|
||||
| [EQUIPMENT Service Engineering - Configuration](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10L41-01EN.pdf) | IM 36K10L41-01EN | 3rd Edition, Sep. 2023 |
|
||||
| [Data Access Engineering](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10L45-01EN.pdf) | IM 36K10L45-01EN | 3rd Edition, Sep. 2023 |
|
||||
| [Data Set Service Engineering](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10L50-01EN.pdf) | IM 36K10L50-01EN | 3rd Edition, Sep. 2023 |
|
||||
| [Exchange Tool Engineering](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10L55-01EN.pdf) | IM 36K10L55-01EN | 3rd Edition, Sep. 2023 |
|
||||
|
||||
### Language
|
||||
|
||||
| Document | IM Number | Edition |
|
||||
|---|---|---|
|
||||
| [Class Description Language - Traditional](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10P10-01EN.pdf) | IM 36K10P10-01EN | 3rd Edition, Sep. 2023 |
|
||||
| [Class Description Language - Java](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10P11-01EN.pdf) | IM 36K10P11-01EN | 3rd Edition, Sep. 2023 |
|
||||
| [Report Generation Language](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10P20-01EN.pdf) | IM 36K10P20-01EN | 3rd Edition, Sep. 2023 |
|
||||
| [Data Set Service Language](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10P30-01EN.pdf) | IM 36K10P30-01EN | 3rd Edition, Sep. 2023 |
|
||||
|
||||
### Setup
|
||||
|
||||
| Document | IM Number | Edition |
|
||||
|---|---|---|
|
||||
| [CI Portal Setup](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10R10-01EN.pdf) | IM 36K10R10-01EN | 3rd Edition, Sep. 2023 |
|
||||
| [Setup File Editor](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10R20-01EN.pdf) | IM 36K10R20-01EN | 3rd Edition, Sep. 2023 |
|
||||
| [Graphic Display Setup](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10R30-01EN.pdf) | IM 36K10R30-01EN | 3rd Edition, Sep. 2023 |
|
||||
| [Report Server Setup](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10R40-01EN.pdf) | IM 36K10R40-01EN | 3rd Edition, Sep. 2023 |
|
||||
|
||||
## Not Listed in the Map
|
||||
|
||||
These files are in the `EN` folder but do not appear in `ciserver.pdf`:
|
||||
|
||||
| Document | IM Number | Edition |
|
||||
|---|---|---|
|
||||
| [CI Server Software License Agreement](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K01A20-01EN.pdf) | IM 36K01A20-01EN | 1st Edition, Jan. 2021 |
|
||||
| [CI Server Terms and Conditions of Open Source Software](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K01A30-01EN.pdf) | IM 36K01A30-01EN | 2nd Edition, Mar. 2022 |
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
# 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