Skip to content

Conversation

@tburms
Copy link

@tburms tburms commented Aug 30, 2023

No description provided.

* `StrongLoop/LoopBack <https://loopback.io/doc/en/lb4>`_ by IBM
* `TerminusDB <https://terminusdb.com/docs/terminusdb/#/>`_
* Tesla Motors (internal)
* `Wikimedia Foundation <https://www.wikimedia.org/>`_, technical documentation for Wikimedia projects and open-source software

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you mean to link to https://www.mediawiki.org? I don't see any technical documentation at https://www.wikimedia.org, let alone docs conforming to the Diátaxis framework.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because the technical documentation for Wikimedia projects is scattered across many wikis and other platforms, it seemed most succinct to link to that page because it links to all the many projects. I guess I also thought the goal was to link to the organization's website, not a specific set of documentation. That said, maybe a link to developer.wikimedia.org would be better?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

technical documentation for Wikimedia projects is scattered across many wikis and other platforms

Right, it's quite scattered, but I also think much of it doesn't conform to the Diátaxis framework, so it probably would be helpful to highlight specific Wikimedia docs that do adhere to it. Are there many that do? 🤔

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are working on it! Diátaxis is the framework we're using for all our doc work and education about tech writing: https://www.mediawiki.org/wiki/Documentation/Toolkit.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's great to hear! So I probably would suggest linking to the toolkit page in this PR (or better yet, the "Templates for common document types" section directly), unless there is a particular instance of Wikimedia docs already structured that way that you think would be worth highlighting. Otherwise, just linking to wikimedia.org seems like it might confuse people who actually follow the link expecting to see usage of the framework there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants