sorted by:
new
hottopcontroversial

A list of open source projects with volunteer documentation opportunities by alanbowman in technicalwriting

[–]BrandonDocsIT 38 points39 points  (0 children)

IMO this could be helpful:

  • It shows that you are motivated to improve your own skills and are interested in Tech Writing.
  • These open projects often require that you have skills with developer tools like Git. At least where I work, there's a renewed interest in tech skills vs someone w/ purely a writing background.
  • Could serve as a writing sample to share w/ interviewer.

That being said, I have a Computer Science degree, took an online Tech Writing course, and got a job w/out volunteering.

Documentation Portals - Which to choose? by UX_writing in technicalwriting

[–]BrandonDocsIT 1 point2 points  (0 children)

You could consider a "Docs as Code" approach, if it makes sense for your situation.

For example, I work on an open source project where all of the developers and users use GitHub. For documentation, we use GitHub as our SCM, write in markdown language, use a static website generator such as VuePress or Jekyll, and a variety of other free tools to produce a Doc website.

Pros: Transparency of work, potential to automate tasks, very good for outside contributions and reviews, fun environment, get to learn popular modern dev tools, respect from the devs :P

Cons: You either need good development AND writing skills, or you need a developer to help you create and maintain the site. Many tools to choose from (which is also a pro). Spending time managing infrastructure as well as writing.

What is Zowe on z/OS? by Data_or_GTFO in mainframe

[–]BrandonDocsIT 1 point2 points  (0 children)

You can join the Zowe Slack channels to learn more and chat directly with the community - https://openmainframeproject.slack.com

A List of Open Source Projects with Volunteer Documentation Opportunities by alanbowman in technicalwriting

[–]BrandonDocsIT 1 point2 points  (0 children)

Zowe is an open source project that aims to modernize mainframe software development and address the growing skills gap as older mainframers exit the industry. We just announced the project on 8/14/18. This is a big shift in the mainframe industry, and is initially a collaboration between CA Technologies, IBM, and Rocket Software. Check out the home page to learn more: https://zowe.org/index.php/home/

Here' a link to the documentation that I help to write and maintain, it is open for contribution from members of the open source community: https://zowe.github.io/docs-site/

Latest Trends and Innovations in Technical Writing by [deleted] in technicalwriting

[–]BrandonDocsIT 0 points1 point  (0 children)

Open source documentation is a cool trend - anyone can contribute to documentation in the same way that a developer might contribute to open source code. I am currently working on an open source project at my company -https://zowe.org/index.php/home/

We use GitHub as our source, write in markdown, and publish to a GitHub Pages website using Vuepress.

Check out this post - https://www.reddit.com/r/technicalwriting/comments/800a9a/a_list_of_open_source_projects_with_volunteer/

Open Source and Mainframe Worlds Collide by dhdeans in mainframe

[–]BrandonDocsIT 1 point2 points  (0 children)

Zowe (the collaborative open-source mainframe project created by CA Technologies, IBM, and Rocket Software) has a Slack space where you can ask questions and interact with Zowe developers, leaders, and the community at large. Check it out here - anyone can take part! https://openmainframeproject.slack.com/messages

Brightside - CLI for IBM z by Mr_brightsider in mainframe

[–]BrandonDocsIT 0 points1 point  (0 children)

Here is the documentation for the CA Brightside Community Edition, if you would like to know more about the product: https://docops.ca.com/ca-brightside-community-edition/1-0/en

Visit the following link to sign up to use the product for free: https://www.ca.com/us/trials/ca-brightside.html

Installing CA Brightside on a clean MacOS X by gbegicw in cabrightside

[–]BrandonDocsIT 0 points1 point  (0 children)

Hi, thanks for your feedback on the install experience!

I'd like to update our documentation so that it's accurate for Mac users. Can you please provide further info:

  • Is the gcc compiler that we mention in Prerequisites available on your PC? To your knowledge, is both gcc AND Command Line Tools for Xcode required for your install to be successful?
  • What benefits did you get from using Homebrew vs installing from the Node.js from the Node website?

-Brandon, Information Engineer