Skip to content
Skills Library
Programming · Writing

documentation

/documentation

Use it when asked to write docstrings for modules, functions and classes. Do not use it when writing pages in docs/ such as concepts, guides or examples.

Repository
protuna ↗
Licence
MIT
Last repository change
05.11.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
0
Deprecation

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

Licence

MIT, open: use and modify while retaining author attribution.

What it does and when to use it

Use it when asked to write docstrings for modules, functions and classes. Do not use it when writing pages in docs/ such as concepts, guides or examples.

Original author description

Use it when asked to write docstrings for modules, functions and classes. Do not use it when writing pages in docs/ such as concepts, guides or examples.

How it works

  1. General instructions
  2. Module docstring
  3. Class and function docstring
Original SKILL.md headings · 43 lines, 588 words
SKILL.md preview
---
name: documentation
description: Use it when asked to write docstrings for modules, functions and classes. Do not use it when writing pages in docs/ such as concepts, guides or examples.
---

## General instructions

- Use plain language. Don't be too verbose; clear and succinct communication is important.
- Make sure docstrings are compatible with google python style guidelines.
- Docstrings should be written in rst compatible format for automatic documentation generation with sphinx.
- Docstrings may already exist containing hints/instructions from the user in form of rough notes and citations, build on top of these notes and instructions when present.
- When writing examples in the docstring to illustrate the API, provide a short description of what the example demonstrates then follow with the code snippet.

---

## Module docstring

- Start module docstrings with a short noun phrase naming the module’s purpose or responsibility, such as “Storage management for candidates and evaluations.”
- Include doctest compatible usage examples on how to interact with the module when feasible – when small illustrative input and outputs are possible.
- Keep these examples faithful to the module usage rather than creating obscure examples as a work around for doctest feasibility.
- When doctests are infeasible – example leads to heavy computation/download etc. – mark the example to skip doctests, they'll just act as illustrations for the user.
- Examples should be simple and with the intent of clarifying the API.
- When talking about specific functions/classes in the module always provide links to them that sphinx can parse. For example, :func:`func_name`
- The module level docstring should act as the central thesis for the module - a short reference guide.

---

## Class and function docstring

- Only document functions/classes that are public.
- When describing a function's behavior always describe what a function does and not how it does it. The only exception is when the function is a specific algorithm or mathematical calculation so explaining the steps clarify the function behavior.
- When a function/method/class is just a wrapper around another then only write detailed documentation for one and cross-reference to it from the others.
- When both a functional and object-oriented API to the the same functionality are provided document the class and cross-reference to it from the function.
- Prefer math equations to describe the function behavior when the function is a specific formula or calculation.
- Use .. note:: , .. warning:: and .. seealso:: in documentations where appropriate.
- Include doctest compatible usage examples with docstrings (with the same caveats as those mentioned for module level) for non-trivial classes and functions.
- When hinted in comments that a implementation follows from a paper, cite the appropriate paper from `references.bib`. If the citation is not found in the file add the appropriate citation there (don't do this from memory, fetch the bibtex online) and cite it. Inform the user when you do this.
- Document attributes of dataclasses using "Args:" instead of "Attributes:" – required for proper autodoc parsing.

### Parameter descriptions

- Describe what each argument supplies and what it is used for in the enclosing API. Assume readers already understand the underlying abstraction; do not repeat its general definition.
- For component arguments, prefer a short noun phrase identifying their role, followed by context where needed. For example: `sampler: The proposal generator to sample candidates from.`
- Explain defaults and special values defined by this API when their meaning affects usage. Do not describe conversions performed by another API as defaults here.
- Keep straightforward descriptions short. Add detail where it clarifies a meaningful behavior or configuration requirement.
- Avoid assumptions about an input's origin or purpose that the API does not require.

Versions

RepositoryScoreLicence
This page · kumarshreshtha/protuna100MIT
software-combined/SC_AI100Apache-2.0
DaveSkender/Stock.Indicators100Apache-2.0
mcouthon/agents100MIT
YLfjuk/deltafold100MIT
comet-ml/opik100Apache-2.0
runwield/runwield100MIT
anthropics/knowledge-work-plugins100Apache-2.0
luocfprime/labtasker100Apache-2.0

Database snapshot: 13.11.2026 · package version 5b3645fb1f3f (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

  • 100write-docs
    Use when writing or editing documentation pages (concept pages, how-to guides, API reference prose, tutorials) under docs/. Provides the writing style, voice, and structural rules for Agenta docs. Apply this skill before drafting any new docs page, and include it in the brief…
  • 100write-docstrings
    Writes and reviews docstrings in this repo. Use when writing new docstrings, reviewing existing docstrings, or editing docstrings.
  • 100documenting
    Writes or updates project documentation (README, docs/, docstrings, decision log). Use when behaviour, setup, or architecture changes, or when asked to document something.
  • 95documenting-python-libraries
    Creates comprehensive Python library documentation including Google-style docstrings, Sphinx setup, API references, tutorials, and ReadTheDocs configuration. Use when writing docstrings, setting up Sphinx documentation, or creating user guides for Python libraries.
  • 100documentation-generation
    Generates project documentation including READMEs, docstrings (JSDoc, JavaDoc, Python docstrings), OpenAPI prose, and CI/CD doc pipelines. Use when asked to generate docs, write docstrings, automate documentation, or create README files.
  • 100docs-writer
    Write and update developer documentation (READMEs, docstrings and code comments, ADRs, CHANGELOG entries in Keep a Changelog format, and API usage docs) based on the actual code, with commands and examples that run. Use when the user asks to document a project, module, function…

Feedback and reports

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