Feature #15670

Improve the navigation of the VeraCrypt documentation

Added by sajolida 2018-06-18 16:00:39 . Updated 2018-09-05 16:21:27 .

Status:
Resolved
Priority:
Normal
Assignee:
Category:
Target version:
Tails_3.9
Start date:
2018-06-18
Due date:
% Done:

0%

Feature Branch:
Type of work:
End-user documentation
Blueprint:

Starter:
Affected tool:
Deliverable for:
299

Description

Right now we have 4 sections:

  • Unlocking a file container
    • Using Files
    • Using Disks
  • Unlocking a partition
    • Using Files
    • Using Disks

During the user testing of the VeraCrypt beta all the participants (5/5) ended up following a wrong section of the doc. Even though they lacked a good understanding of the VeraCrypt concepts, the major problem was about navigating between the 4 sections, understanding which one was about what and making it clear what the section people were following was about.

I had the following ideas (to be tried out):

  • Use longer section title like “Unlocking a file container using the Files browser”. See also Feature #15669.
  • Use drawings to explain and visualize “file container” and “partition”.
  • Use toggles to only display the relevant sections. This might not be enough unless we can trigger closing down all the other sections.
  • Use separate pages for different sections.
  • Clarify that “partition” also applies to entire disks.

Subtasks

History

#1 Updated by sajolida 2018-06-20 16:27:03

  • Deliverable for set to 299

#2 Updated by sajolida 2018-06-25 16:33:46

  • Target version set to Tails_3.9

#3 Updated by sajolida 2018-06-27 14:24:30

  • QA Check set to Ready for QA

I did that with:

  • 500af66ab4 which is the real solution I believe.
  • f6dbc56686 to clarify that ‘partition’ also apply to entire disks
  • 660d40dbc0 to explain with graphics the different between ‘file container’ and ‘partition’

I think that this would have been enough to solve the problems during the user testing. I’d rather avoid splitting the page or using toggle as it would introduce another classes of problems.

#4 Updated by sajolida 2018-06-28 08:02:46

  • Assignee changed from sajolida to cbrownstein

Cody agreed to review that.

#5 Updated by cbrownstein 2018-07-19 17:28:51

  • Assignee changed from cbrownstein to sajolida
  • QA Check changed from Ready for QA to Pass

Everything looks good!

#6 Updated by sajolida 2018-07-26 09:53:57

  • Status changed from Confirmed to Fix committed
  • QA Check deleted (Pass)

#7 Updated by sajolida 2018-07-26 09:54:33

  • Assignee deleted (sajolida)

#8 Updated by intrigeri 2018-09-05 16:21:27

  • Status changed from Fix committed to Resolved