markdown-writing-prompts

Files (1)

• SKILL.md

SKILL.md (first lines)

- Markdown prompts (eg. SKILL.md and AGENTS.md files are intended for human consumption)
- Add 'do this' and 'don't do that' blocks. Denote them with emoji
- Add a rationale - this helps the human reader understand why the instruction is there. 




## Skills

### Naming convention 

Skills are kebab-cased and starts with a common topic. 

eg. 

```
markdown-general
markdown-writing-prompts

ts-general
ts-testing
```

**Rationale:** Lexicographic ordering means related skills all exist in the same place, allows user muscle memory to bring up related skills. 


### Prompt format

- Give each instruction a ✅ **Do this** and a ❌ **Don't do that** block, where it helps.
- Give each instruction a rationale. It helps the human reader understand why the instruction is there, and so judge when it no longer applies.


## Example blocks

Include `Good 👍` and `Bad 👍` in the example blocks themselves

`````markdown
```js
// 👍 Good
let i = 0; 
```

```js
//  👎 Bad
var i = 0; 
```
`````

**Rationale:** Putting the indicator in the block makes it clear which block it belongs to.

From dwjohnston/agent-skills, MIT.

More from dwjohnston/agent-skills