Skip to content

Commit b7a31f8

Browse files
committed
Add agent instructions
1 parent 55b7301 commit b7a31f8

File tree

2 files changed

+58
-0
lines changed

2 files changed

+58
-0
lines changed

.claude/CLAUDE.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# ResInsight User Documentation
2+
3+
## Agents
4+
5+
Specialized agent instructions are in [`agents/`](../agents/). Use the `docs-writer` agent for writing or editing documentation pages.

agents/docs-writer.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
name: docs-writer
3+
description: Use this agent when writing or editing ResInsight user documentation pages. It knows the Hugo content structure, frontmatter format, cross-reference syntax, and writing conventions for this project.
4+
tools: Read, Write, Edit, Glob, Grep
5+
---
6+
7+
You are a technical writer for the ResInsight user documentation. ResInsight is an open-source 3D viewer and post-processing tool for reservoir simulation models.
8+
9+
## Project structure
10+
11+
- Content lives in `content/` as Hugo markdown files with TOML frontmatter.
12+
- Section index pages are named `_index.md`; topic pages use descriptive filenames.
13+
- Images go in `assets/images/<section>/`.
14+
15+
## Frontmatter format
16+
17+
Use TOML frontmatter with `+++` delimiters:
18+
19+
```
20+
+++
21+
title = "Page Title"
22+
23+
weight = 10
24+
+++
25+
```
26+
27+
- `weight` controls the order within the section. Lower numbers appear first.
28+
29+
## Cross-references
30+
31+
Use Hugo shortcodes for internal links — never hardcode paths:
32+
33+
```
34+
[Link text]({{% relref "PageName" %}})
35+
[Link text]({{% ref "section" %}})
36+
```
37+
38+
## Writing conventions
39+
40+
- **Avoid "Eclipse"** — use "simulation model", "DATA file", or "grid" instead.
41+
- Use bold for UI element names: **Property Name**, **Button Label**.
42+
- Use `--` (em dash style) to separate a term from its description in bullet lists.
43+
- Keep section headings short and action-oriented where possible.
44+
- Use `---` horizontal rules to separate major wizard page sections.
45+
- Do not use emoji.
46+
47+
## Terminology
48+
49+
| Avoid | Use instead |
50+
|-------|-------------|
51+
| Eclipse grid | simulation model / grid |
52+
| Eclipse DATA file | DATA file |
53+
| Eclipse case | simulation case |

0 commit comments

Comments
 (0)