Dynamic Help in Visual Studio .NET
Dynamic help is help that automatically shows help for the page the user is on. The user does not need to click anything (if the help pane is showing) for the help associated with that page to appear. If you have Flare and turn on its dynamic help, you can see an example.
The following image automatically shows the help pane that corresponds to the Style editor.
When you move to the Topic tab, where the XML editor is available, the dynamic help pane automatically shows the help for the XML editor.
Sponsored
On the one hand, automatically showing the help relevant to the page makes the help immediate and relevant. On the other hand, if you leave the help pane exposed, the constantly changing topics might be a little distracting. In that case, there's a push-pin that you click to auto-hide the pane.
If you've written dynamic help, I'd like to interview you on Tech Writer Voices (email me at [email protected]). I'm wondering how hard dynamic help is to implement, whether users find it useful or annoying, and the different ways you integrate it with your applications.
About Tom Johnson
I'm an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, agent skills, tech comm careers, and more. Check out my AI courses for more on the latest in AI and tech comm. If you're looking for info about documenting APIs, see my API documentation course.
If you're a technical writer and want to keep on top of the latest trends in tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me.
Finally, I want to note a couple of things. I usually write the first drafts of my posts myself and then use AI to improve accuracy, clarity, and detail in places, so my writing is a mix of human and AI. (Hopefully that's not too off-putting.) Also, the opinions I express on my blog are my own perspectives, not those of my employer.