Functionality notes and test cases

Notes related to the client's functionality and test cases, per issue #27.

Get started

Step 1: Install the OLD version of the client

• Download the Binaries link from the legacy download page
• Unzip and install per directions in the github gh-pages branch on versionone.github.io/VersionOne.Client.VisualStudio. Note that this build appears to only install into Visual Studio 2012

Notes while reading original docs:

• Add a Features heading under Description and speak to the Developers and Tester end-users for whom this plugin applies, using words like "you", and "can" and "lets you" right in the beginning, not just later on.

  • Use short headings to call out key capabilities for Devs and Testers -- tell them what they can Accomplish from Visual Studio
  • Use a few more screen shots showing how it exposes VersionOne functionality inside studio
    • Add a screenshot that shows the Login Successful step so user knows when its DONE
    • Do not bury the "To access this window" instruction in a second sentence.
      • Make them simple, short
      • Add screen shots showing the View > Other Windows > steps and the VersionOne Projects and VersionOne Tasks items
  • Study the examples of popular add-ins in the Visual Studio Gallery, like:
    • VS10X Code Map (most popular): http://visualstudiogallery.msdn.microsoft.com/1c54d1bd-d898-4705-903f-fa4a319b50f2?SRC=Home
    • Resharper: http://visualstudiogallery.msdn.microsoft.com/EA4AC039-1B5C-4D11-804E-9BEDE2E63ECF
    • Web Essentials 2012: http://visualstudiogallery.msdn.microsoft.com/07d54d12-7133-4e15-becb-6f451ea3bea6
    • Power Productivity Tools: http://visualstudiogallery.msdn.microsoft.com/d0d33361-18e2-46c0-8ff2-4adea1e34fef

• Add screen shot and clear short-cut instructions (Alt + Enter) for invoking the Visual Studio properties grid for the additional asset details (It's buried without a screenshot at the end of the Usage heading now).

• Broken: "Latest integration available" link is just plain broken

  • Should link to GitHub "Releases"
  • Should also support installation via Chocolatey package!
  • Should Publish to VS Gallery

• Make spacing consistent between major headings and the text after them.

• Change the Proxy Settings information.

  • Give it its own heading like "Troubleshooting" or "Common Configuration Problems".
  • Move the information above, before the Configuration parameters
  • More notes: If user does not know if they need a Proxy Server, then it seems like the natural thing to do would follow the examples table, which might be the wrong thing to do.
  • JG note: When we use Fiddler, the plugin already uses Fiddler, because Internet Explorer / Internet Connection settings have already been set to this.
    • Is the intention of these settings to give the user a way to force the client to use a Proxy that is different from the global proxy settings?

• Correct "Task, and Test" to be "Tasks, and Tests"

• Change "workitem" to "Workitem"

• Change image to show "2012" or not at all instead of 2010

• Change "https://www5.v1host.com/vs2010addin" example to something without the name "2010"!

• Question: What's our documentation style for asking users to navigate? Should we have a better navigation style like Tools > Options > VersionOne, not " go to the View menu, select the Other Windows sub-menu, and select VersionOne Projects. To choose a specific project to work on, simply navigate the tree and select it." without any bolding or callouts?

Carlena

Likes

• Screenshots help
• Comprehensible as an end-user

Dislikes / Needs Improvements

• Application URL filled out can be confusing
• Should insert a step between Run VSIX and Configure to instruct user to open Visual Studio itself
• Questions:
  • Can the plugin detect whether the VersionOne instance in the "Application URL" field is in "Windows Integrated Authentication" mode, rather than forcing the user to configure this?
  • What if they get it wrong?
  • Don't we only support one mode per instance anyway?