BigHugger
sk Skill · fdiblen

rseng-documentation

Covers how to document research software at every level: writing a README, code-level docs (comments, docstrings, API and CLI help), project docs (INSTALL, CONTRIBUTING, LICENSE, CITATION, changelog), publishing hosted documentation with Read the Docs, and capturing a Research Software Story. Use when the user asks how to write or improve a README, decide what documentation their project needs, add docstrings or…

installs 8w
0
30-day movement
starts with the next reading
Related entries
1
Connections
0
Python
Host repository
fdiblen/rseng-agent-skills
Version
0.2.0
Licence
CC-BY-4.0
Host stars
16
Host language
Python