Skip to content
Skills Library
Medicine & health · Writing

write-wiki

/write-wiki

Create user documentation for the HMIS wiki following writing guidelines. Use when creating documentation for end users (pharmacy staff, nurses, doctors, administrators). Creates documentation directly in the sibling ../hmis.wiki directory.

Repository
hmis ↗
Licence
GPL-3.0
Last repository change
26.10.2026

Assessment and security

100/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content35 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
1
Scripts
0
HTML comments
0
URLs in SKILL.md
1
Deprecation

No signals detected. Repository changed on 26.10.2026, without references to retired models or APIs.

Licence

GPL-3.0, otwarta.

What it does and when to use it

Create user documentation for the HMIS wiki following writing guidelines. Use when creating documentation for end users (pharmacy staff, nurses, doctors, administrators). Creates documentation directly in the sibling ../hmis.wiki directory.

Arguments

/write-wiki [module/Feature-Name]
Original author description

Create user documentation for the HMIS wiki following writing guidelines. Use when creating documentation for end users (pharmacy staff, nurses, doctors, administrators). Creates documentation directly in the sibling ../hmis.wiki directory.

How it works

  1. Arguments
  2. Target Audience
  3. Required Structure
  4. Writing Rules
  5. What NOT to Include
  6. File Location
Original SKILL.md headings · 57 lines, 291 words
SKILL.md preview
---
name: write-wiki
description: >
  Create user documentation for the HMIS wiki following writing guidelines. Use when
  creating documentation for end users (pharmacy staff, nurses, doctors, administrators).
  Creates documentation directly in the sibling ../hmis.wiki directory.
disable-model-invocation: true
allowed-tools: Read, Write, Glob, Grep, Bash
argument-hint: "[module/Feature-Name]"
---

# Write Wiki Documentation

Create end-user documentation directly in the sibling `../hmis.wiki` directory following the project's wiki writing guidelines.

**IMPORTANT**: Wiki files live ONLY in the sibling `../hmis.wiki` directory. Do NOT create wiki markdown files inside the main project repository - this causes git submodule issues.

## Arguments

- `$0` - Module and feature name (e.g., `Pharmacy/Stock-Transfer`)

## Target Audience

- Pharmacy staff, nurses, doctors, administrators
- Non-technical healthcare professionals
- Focus on **how to use features**, not implementation details

## Required Structure

Every wiki page must include these sections:

1. **Overview** - What the feature does and why (2-3 sentences)
2. **When to Use** - Specific scenarios and business triggers
3. **How to Use** - Step-by-step with navigation paths
4. **Understanding Messages** - Success, warning, and error messages
5. **Best Practices** - Tips for effective use
6. **Troubleshooting** - Common problems and solutions
7. **Configuration (Admin)** - Settings that affect the feature
8. **FAQ** - Common questions

## Writing Rules

- **Active voice**: "Click the Submit button" (not "The button should be clicked")
- **Imperative mood**: "Enter the patient ID"
- **Bold UI elements**: **Pharmacy** > **Reports** > **Stock Ledger**
- **One action per step** in numbered procedures
- **No code, no technical details** - no Java classes, SQL, file paths, or method names

## What NOT to Include

- Code snippets, file paths, line numbers
- Java class names, method signatures
- Database schema or SQL queries
- JSF component IDs or backend beans
- Developer debugging information

## File Location

Create files at: `../hmis.wiki/$0.md`

Ensure the wiki repo exists first:
```bash
test -d "../hmis.wiki" || (cd .. && git clone https://github.com/hmislk/hmis.wiki.git && cd hmis)
```

After creating, suggest using `/publish-wiki` to commit and push to the GitHub Wiki.

Versions

The database has no other skills named write-wiki.

Identical content appears in 1 other GitHub folders. We show one copy with the highest score.

Database snapshot: 13.11.2026 · package version 5fceb6497aeb (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 100publish-wiki
    Publish pending changes in the sibling hmis.wiki repository to GitHub. Use when wiki documentation has been created or edited in the sibling ../hmis.wiki directory and needs to be committed and pushed to https://github.com/hmislk/hmis/wiki.
  • 100publish-wiki
    Publish pending changes in the sibling hmis.wiki repository to GitHub. Use when wiki documentation has been created or edited in the sibling ../hmis.wiki directory and needs to be committed and pushed to https://github.com/hmislk/hmis/wiki.
  • 90darukade
    Read-only Darukade (darukade.com) pharmacy: products, prices, ingredients, usage, reviews. Use when the user asks about Darukade Pharmacy (darukade.com) or wants doctors, clinics, labs, appointments or pharmacy products in Iran.
  • 100wiki-generation
    Generate structured documentation from codebases — architecture mapping, page writing, and onboarding guides. Use when asked to create a wiki, document a repo, generate onboarding docs, map architecture for documentation, or produce a documentation plan from source code.
  • 100wiki-generation
    Analyze a repository and generate or incrementally update an agent-friendly wiki. Used by /claude-wiki:init and /claude-wiki:update, or when the user asks to generate/refresh codebase documentation as a wiki.
  • 90wiki-architect
    Analyzes code repositories and generates hierarchical documentation structures with onboarding guides. Use when the user wants to create a wiki, generate documentation, map a codebase structure, or...

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.