Resources for writers
Resources for internal Adobe writers and contributors.
SSE/Adobe doc links
Writing tools
Feel free to add links below.
Markdown editors
Markdown is a lightweight markup language that is both easy to read and easy to learn. Therefore, it has rapidly become an industry standard. To write articles in Markdown, we recommend that you first download and install a Markdown editor. Popular options include:
Git/GitHub tools
You can also use command-line tools for performing Git tasks.
Slack channels
- For authoring and publishing troubleshooting and announcements, use the
sccm-assistance
Slack channel. - For editorial questions and discussions, use the
writers-experience-league
Slack channel. - Use an AI bot (currently
exl-singularity-test
) for AI-based feedback. It can be surprisingly effective.
Design resources design-resources
Git and GitHub learning resources git-learning-resources
If you are unfamiliar with Git or GitHub, check out these resources.
- Git basics: Basic overview of Git basics.
- Learning Git and GitHub
- Interactive primer: This is an online git tutorial. It exposes you to the basics of git.
- Git and GitHub for Writers: Sign up for a trial and get a discount. Based on using command-line tools but still an excellent overview from a writer’s (not developer’s) perspective.
- GitHub training services: A listing of tutorials and training offerings from GitHub.
- Pro Git e-book web or PDF: View this thorough Git reference in HTML or PDF format.
- GitHub Guides: The home of GitHub documentation.
- Glossary: A handy glossary of git and GitHub terms.
Logging JIRA tickets
If someone asks you to log a jira ticket, here are the steps:
-
Sign in to https://jira.corp.adobe.com (requires corp/vpn access).
-
Click Create.
-
For Project, choose Experience League (UGP).
-
For Issue Type, choose Bug or Enhancement Request.
-
Select a different priority if warranted.
-
Specify an Assignee if someone asked you to. Otherwise, leave Assignee blank.
-
Specify a Summary (title) and Description.
-
Click Create.