5
votes
How do I give proper credits in a documentation site
I'm currently working on a site for learning MonoGame: https://learn-monogame.github.io/. The front page alone is a collaboration between 3 people. Do you guys know of a good way to give credits for each page? Is that a good idea? I'm currently thinking of adding a section at the bottom of each page with categories like:
- Written by
- Edited by
- Corrections by
- Brainstormed with
With a link to each contributor's preferred social medial. I'm not sure where to look for inspiration for giving credits in a documentation site.
From a reader's point of view, I think it can be nice to get introduced to members of the MonoGame community. Perhaps check out their released games or the ones they are working on.
For my own projects I usually just drop a CONTRIBUTORS file in the git repo. Or if I'm feeling lazy I'll put a note in the README to run
git shortlog -sto see the project's contributors.Looking at the first readthedocs site that popped into my head, they just have "© Copyright 2018, restic authors" at the bottom of the page and then there's the little "Contributors" section on their github page that shows who made contributions. I could easily be missing something, but other than that I don't see any other place where they give credit to the contributors.
For anything more complex than that I would probably put up an "About Us" page with the Author/Editor/etc. info you describe. For contributions on a more granular basis, you already have links to the project's social media where people could presumably get a sense of who did what.
I guess I was trying to complicate stuff. A single page with the names could be enough.