Page MenuHomePhabricator

[Documentation] Write user docs for Citation Toolkit
Closed, ResolvedPublic

Description

This task involves creating on-wiki documentation for the Citation Toolkit. This is a group of three small tools: I recommend you start with:
https://citation-toolkit.toolforge.org/highlight-citations/

Steps:

Explore the tool: Click the "Go to Tool" button on its Toolhub page.

Note: Please use this wiki-text template: https://www.mediawiki.org/wiki/Documentation/Tool_doc_template

Create on-wiki docs:

  • In your user space, create a new subpage (for example https://meta.wikimedia.org/wiki/User:{YOUR USERNAME}/New_page
  • Write clear user guides (e.g., installation, troubleshooting).
  • Get feedback from another hackathon participant - have them review your documents and provide suggestions.
  • Reach out to the maintainer of the tool to tell them about your documentation and suggest publishing it with the tool. You need to work with the tool maintainer to decide where they want to publish the documentation.

Use the guide at https://www.mediawiki.org/wiki/Documentation/Tool_docs to help you!

Skills Required: Technical writing, MediaWiki editing, Toolhub navigation.

Event Timeline

Eugene233 renamed this task from [Documentation] Write user docs for Redirect Creator to [Documentation] Write user docs WikiLeaderboard.Mar 29 2025, 10:18 AM
Eugene233 updated the task description. (Show Details)
TBurmeister renamed this task from [Documentation] Write user docs WikiLeaderboard to [Documentation] Write user docs Citation Toolkit.Mar 29 2025, 2:47 PM
TBurmeister renamed this task from [Documentation] Write user docs Citation Toolkit to [Documentation] Write user docs for Citation Toolkit.
TBurmeister updated the task description. (Show Details)
Umar2z changed the task status from Open to In Progress.Mar 29 2025, 7:43 PM
Umar2z subscribed.

You can fill out the WMA contribution form for this task; thank you!

Great job during the Hackathon, everyone! If you want to keep learning and keep contributing to technical documentation, here are instructions: https://www.mediawiki.org/wiki/Documentation/Contribute.
If you want to reach out to the maintainers of the tool you documented, to talk to them about where to add what you wrote in "official" documentation for the Citation Toolkit tool, I suggest you should start a discussion on their User page: https://en.wikipedia.org/wiki/User:Vahurzpu, or reach out via GitLab https://gitlab.wikimedia.org/vahurzpu.

I have also added them as a subscriber to this task in case communicating on Phab is easier.

Thanks again for your amazing work this weekend.