Share helpful information in Community
In the AppDynamics Community, you can post a question or present your own information. When you begin to write a post—besides capturing all facts, steps, and thoughts—you want to keep your target reader in mind and bring them along with your thought process.
Because your readers are likely to have used the Community’s search capabilities to find meaningful content, keep relevant keywords top of mind as you write your post.
NOTE | Anyone is free to browse the content in the AppDynamics Community without registering or signing in. But, if you’d like to engage by asking a question, replying to a topic, or giving kudos to another user or content, you must be signed in.
To register for the first time, click on the Sign In button at the top right navigation
In this article...
Writing your post, step-by-step
-
Post Subject
A subject (the post's title) that makes your intention clear will help readers understand the scope of your question or solution. Even though members can surface content by searching, a pertinent title helps make your post more findable. If you can also make it visually scannable, that title will do even more to surface your post.
NOTE | Try to limit the length of your title to between 30 - 50 characters, so all of it is visible on summary pages without being truncated. Can’t keep it below 50 characters? Try to frontload the most relevant keywords and meaning early in the title.
TIP | Often, the best title comes into focus AFTER you're finished writing the body of the content. We recommend you review your headings and titles as a final step.
- Post Body
In your post’s body, give readers enough context so they can understand your situation—how they might help answer your question, or how they might apply your solution.
- What options have you already tried?
- Have you eliminated any options? What are they, and why won't they work here?
- What possibilities are you comparing?
- What isn’t compatible with your situation?
|
Post form hints, with examples
|
|
Products & version numbers
|
Specify the products and their version numbers for Controllers, Agents, 3rd party tools, or other relevant products
e.g., Controller v20.3.2, Docker 20.10.5
|
|
Operating system and version
|
OS and version
e.g., Linux, MacOS 10.15.7, Windows 10 Pro 20H2, etc
|
|
Screenshots
|
Favor screenshots that bring clarity by showing context and detail
NOTE |Be sure to redact private or sensitive information from your screenshots
|
|
Process
|
What strategy did you pursue in your attempts to fix the problem? What was the order of steps taken?
|
|
Code*
|
Review the Community article Security Dos and Don'ts for clarity on how to safely treat code examples
|
How can I best organize my thoughts?
You want to give readers enough context so they have a clear sense of your journey. Help them understand how they can either contribute to or learn from it.
A structural framework is a helpful writing tool for helping you create a narrative that best defines your situation. Popular frameworks include:
7 Questions: Who, what, when, where, why, how, how much
CARL: Context, Action, Results, and Learning
SCQA: Situation, Complication, Question, Answer
-
Review and Finalize
Finally, review your content for clarity, cohesion, and correctness.
Do give that title another look too, in case your writing clarified or changed the post’s theme.
Additional Resources
