Link different design documentations from user documentation
Some user documentations have basic explanation, while power users might want more details. It would be great if the docomentation pages had links to the design documentation regarding those subjects, ideally in specific CSS. Maybe a "+" icon?
- MAC Spoofing:
- unsafe browser:
- incremental upgrades (users ask how it can be upgraded without root):
#3 Updated by sajolida almost 6 years ago
We already have a CSS styling for "Next". Even if we haven't used it
much, see https://tails.boum.org/download/#installation
But that won't work for design docs. And I'm afraid the "plus" sign
might be too ambiguous. We need to make clear this link in going into
the internals. Maybe one of those:
And also, some people we questioning the idea of pointing to the design
docs from the user docs. I don't think that's blocking as long as we
make it clear this is hard core reading. Maybe your proposal can help
with that actually.
#11 Updated by segfault over 2 years ago
- Assignee set to intrigeri
- Type of work changed from Discuss to Research
We discussed this during the October monthly meeting. The following is a summary of that discussion.
Problem description: It happens regularly, that people have questions or doubts about how we implemented what we promise. So we have to manually point them to the design doc. It's somewhat tiring. And chances are a few other people have the same questions/doubts but don't ask. We might also be losing potential new contributors there.
The proposed solution is to link from the documentation pages to the appropriate design pages, so that power users can better find those pages on their own. But we worry about the added complexity for 99% of the readers. We hope that a good web designer will find a good solution.
We agree that, to be more welcoming to that web designer, we would like to first propose a few (say, 5-10) design docs to link.
Intrigeri volunteers to create this list of design docs to link. Then we have to wait for someone to do the web design work. The actual implementation could be done by anonym, segfault or u.