Soon I will be starting to write a lot of documentation and procedures in order to improve basic on-boarding and fill up gaps of undocumented decisions or anything that is missing from a project that I work on with a lot of people at work.
At the moment I am checking the GitLab, CloudFlare and Google, Microsoft and IBM documentation procedures and docs in order to get the best one for me but I think and feel that I am missing something.
Do you use any specific documentation procedures, guides or you come up with your rules and structure?
I understand this is a story about cultures and civilizations and grand sweeps of history, And the narrator even tells you this is HER story in the latest episode, which means its not entirely factual or full of details ... ... but I can NOT get past the lazy details that show the writers don't actually understand technology or realistic depiction of some of the things they want us to see.
EXAMPLE : The SLOW ship that takes the foundation to terminus must be moving at 30? or more light years per day. (50k light years... 5 years of travel)
Anacreon and Thespis are neighbors to each other, and with a "SLOW" ship being able to traverse 30 lightyears a day -- why the hell did they put Anacreon and Thespis in the same view of a single small telescope on Terminus as though their neighboring planets? I mean there's a million reasons why a small tripod mounted telescope would never be able to see those planets in that orientation ... but there it is. The argument being, a slow ship that goes 30 light years per day would have about 85 individual stars with in 1 days travel (https://en.wikipedia.org/wiki/List_of_star_systems_within_30%E2%80%9335_light-years as an example). Why wasn't this a star map on a wall?
EXAMPLE : The Anacreons invade Terminus, set up a "flak cannon", and Salvor fails to mention that at all to the approaching imperial ship. And the approaching Imperial ship, despite being a top of the line jump ship, apparently has no combat landers, and has zero inclination to establish any sort of orbital awareness of the situation on the ground before landing. And where are these vaunted energy shields that the empire seems to have plenty of? A single ground cannon just punches right through that in one or two shots?
I've got no problems with a crack team of Anacreon heros being able to overcome or defeat the finest the empire can throw at them, but this was just lazy plot tools.
EXAMPLE : In the latest episode, when Salvor turns off the null field, immediately a flock of birds fly by... as though they were already in flight.
And almost immediately all of the armed Anacreons show up. Wasn't the vault on the horizon? (Why didn't Salvor drive there?).
Then the Thespian's land... AFTER one of their ships is commendeered by The huntress. The thespian pilots rolled over hard on that one, don't they check in with each other? Didn't t
... keep reading on reddit ➡Hey /r/technicalwriting,
I'm wrapping up my compsci degree this fall and I haven't really fallen in love with the profession. I like technology, but I don't think programming is really for me. Some of my more enjoyable courses I've taken were a basic technical writing course, and an agile/scrum course. I also have a Film degree that will be finished up in the same time, but I don't particularly enjoy that career path.
I currently work at a IT firm, in which I lead the 24/7 helpdesk. A lot of my job consists of maintaining a wiki KB for our team. Some articles consist of troubleshooting steps to take for a specified system, how to fill X report, escalation details for when a type of alert comes in. I also template very basic reports like "log data from X system every Y hours", or "Backups completed this shift". Been doing this for almost 6 years now, and there isn't really a position to grow here.
In my free time, I have contributed to various game wiki's (mainly fighting game ones), consisting of error correction, filling out blank templated sections, and importing information from outside sources (google doc, youtube videos) into a wiki page. I also really enjoy researching some new piece of technology, getting it, and running through a tutorial/instructions on getting it setup.
My question is, do you think Technical Writing is for me? And if so, what are some resources that I could dip my toes into to get a feel for it, or eventually get certified to be a good candidate to be hired.
Thank you for taking the time to read this. Looking forward to your responses!
Edit: I appreciate everyone's feedback they've provided. I'm going to take some courses to get a better feel for formal TW. If I'm liking it, I'll work on getting a cert and start job hunting for a Jr position. Thank you for your words of encouragement and support.
What are some red flags that you’ve experienced during interviews and even while on the job?
Here are some of mine:
- A company where you’re the only technical writer. This usually means that they don’t value documentation as much as they should. You probably won’t receive the support that you need to create quality documentation.
- A company that uses Microsoft Word for their documentation. There’s nothing wrong with Word, but it’s not the best for collaborating and maintaining up-to-date documentation.
As an early-stage startup with an MVP, still seeking Product-Market Fit, how much time do you spend in writing technical documentation?
For example, how much time do you / your technical founder / your developers, spend on documenting technical choices and implementations (such as system diagrams, functional requirements).
Why is it valuable to spend time on it at this stage?
I am currently a heavy equipment mechanic and am looking to transition my career to something less physically demanding. I have always enjoyed writing and have been told by several professors in college that I had exceptional writing skills. I’m sure I need a lot more practice to become proficient in technical writing, and am trying to figure out a way to get more qualified.
By technical writing in heavy equipment, I am thinking something along the lines of writing service information, owners manuals, website articles, etc.
Anybody have any experience with technical writing in heavy equipment? If so what are some things I can do to start transitioning my career in that direction preferably without going back to a university. My highest level of education is an associates degree in Heavy Equipment Technology.
Thank you in advance for your advice.
I have 20 years of technical writing and course development for the military. Since these are not published works, and the awards I received were from the military, should they be included in my BIO for a fiction query letter?
Any advice would be appreciated. Thank you.
I have a masters in engineering and have always been told my technical writing is top notch. I've had a few publications and frequently write tech reports for my corporate job. I think technical writing for STEM topics is a niche that I wouldn't mind doing part time but have no idea how to start. Anyone out there have some experience to share? Is it harder to find work than for general writing?
Hi everyone! I graduated from college a year ago, I did an individual studies degree so I studied computer science and technical writing. I took the first job I was offered out of college which was an environmental health and safety job where I am currently writing a safety manual (think osha regulations and other industry standards and how they apply to our site). I really miss programming and I found a job that would be a technical writer for software. They want familiarity with some programming languages, all of which I know but haven’t used in about a year. They also want writing samples.
My questions are as follows:
- None of my work experience writing samples are in the software industry, so it is common to submit samples that aren’t related to the field you are going into, despite them being technical in nature?
- Am I allowed to say I’m familiar with the programming languages even though I haven’t used them in about a year?
Sorry if the formatting is off, I’m on mobile.
Hello all,
Please forgive my ignorance. I am a writer currently putting together a portfolio. I enjoy writing direct response ads and educational materials. However, I think I'd be good at technical writing and would like to offer something along those lines to a prospective employer.
My question is: does the term 'technical writing' imply technology? Or does it just have to do with explaining complicated systems in an easy-to-understand way?
I have a text course I've written teaching the basics of music theory. It's an insanely abstract and complex topic, which I think I've explained in an approachable and relatable way. Could I put that as a 'technical' example?
Many thanks!
Has anyone taken this course? Specifically, with Samantha Burrier? What are your opinions on the work load, difficulty, presentation, etc?
Like many others, I fear unemployment with an English degree, so I am pursuing technical writing. I'm minoring in professional writing and expect to graduate in December 2022. I'm currently studying the Google it support certificate and I enjoy it. What additional skills do you recommend learning for getting a job in the field?
Hello technical writers,
I do some freelance writing and am putting together a technical portfolio. I feel naturally suited to the whole distill and explain side of this field, but am wondering if you can suggest any helpful resources which outline ... I dunno. Ways to format a document? Standard practices? That kind of thing. :)
Thanks all!
Hi frens. I didn't go to college, and I've been a barista since high school. I could use some help getting my first "real" job in developer documentation.
I have lots of (amateur) experience with front-end web dev, Photoshop, Illustrator, and TouchDesigner, and lately I've been trying to get my hands dirty with open-source projects. I recently set up a Tor relay and wrote an introductory tutorial, and now I'm diving into Ethereum and dapps. A few of my contributions to Ethereum's official docs were just deployed 🎉🎉🎉 I wouldn't have gotten involved if I never found this subreddit, so thank you. Now I'm really excited and motivated.
My current plan is to cruise through the rest of these docs, submit a few more PRs, and hopefully get some feedback from other contributors. I'm also recording all my notes in Markdown and storing them in a Github repository to get more comfortable with these tools.
Now I know my resume isn't doing me any favors, so I want to make sure my portfolio is excellent and really stands out. Here are a few ideas I've been tinkering with. Pls let me know whatcha think.
- Compile my notes and resources on Ethereum and relevant CS concepts. Create some visual representations. Share on Github and a self-hosted wiki website.
- Create a series of short YouTube videos about niche software topics. This is way out of my comfort zone, but it seems like a good way to practice verbally discussing complex ideas.
- Reach out to a bunch of "crypto people" and ask to interview them for a blog post/short video. Again, wayyyy out of my comfort zone and kinda random, but it would be good practice and maybe even good networking. And people (especially crypto people) love talking about their niche interests to a genuinely curious audience.
And of course I have a bunch of boring written software tutorials in mind, but I feel like I need to get creative and "network" pretty hard if I want to succeed. The roles I'm interested in have hundreds of applicants from all over the world.
I'm not totally committed to blockchain tech either. I'm honestly only interested because it seemed exciting and challenging, and I wanted to understand all the annoying, cultish hype. I actually think my initial frustration/skepticism could be a big strength because I can see issues that go unnoticed by the blockchain evangelists.
Thank you in advance for your feedback and guidance - even if you're just telling me i'm unlikely to get the job I want. I really have no idea
... keep reading on reddit ➡So I'm a happy bunny today; I've just verbally agreed the new contract and just need to review and sign the written one. Start in March.
So despite the firm being quite big, their business software arm doesn't have a technical writing department; all they have is some pages in Confluence written by the developers.
So, within reason, I can choose the software, workflows and put the style guide together, as well as writing and producing the content. I can work from home too.
I'm curious what other software tech writers would implement, given a completely blank slate?
I want to plan this out before I go back to college. I have 11 classes to finish to get a degree in technical communication from my university. I want to know what I should do while I am attending school and once I get my degree. My understanding is you have to have a bachelors to get hired. I was curious what I could do to gain experience while I am attending school in addition to what area should I specialize in when it comes to technical writing if I want to make the most money?
Hi guys, Im starting a new job at a company that works on turbines and is contracted with the us military. I’m scared because I’m only 18 and got the job on only the basis that I’m interested in the aviation community (PPL) but I feel really under qualified for the position. Any tips?
Hello all, I've recently become very interested in pursuing technical writing as a career.
I just graduated and currently possess a bachelor's degree in psychology and a bachelor's degree in philosophy. I've seen a variety of opinions on the value of a technical writing degree on this subreddit, but I've decided to pursue a certificate because I think I'd enjoy the coursework as an entry into the field.
I was looking for anyone's recommendation for a specific online program for certification they took? I'm completely open to just about any field that will take me; I'm not sure if there are certain programs which are better suited for a particular subfield.
Any recommendations help, thank you!
Hello!
We’re the authors of “Docs for Developer: An Engineer’s Field Guide to Technical Writing”. Our book, released in October 2021, helps developers design, write, and edit documentation alongside software releases.
It builds on the experience that we have from our careers at companies like Google, the Linux Foundation, Stripe, Monzo, and LaunchDarkly.
If you work with software engineers who need to write documentation on their own, or you’re considering jumping into the field of technical writing focused on developer documentation, this book is for you. You’re welcome to ask us questions here, or if you’d like to join the ongoing book club, you can join through the DevEd Book Club.
I am looking to connect with women who are in the field of technical writing. I'm looking to move into this field because I realized that I like breaking down complex processes and teaching people how to use them. I have not had much luck on the usual channels like Linkedin. I am hoping to have better luck on here. Please DM if you can spare the time. Thanks so much
I’m looking to take it I just want to know what kind of material to expect.
Hi all!
Would anyone be willing to answer some questions over DM about going into Technical Communication and classes at UNT? I mostly just want some guidance/perspective from a alumni who's now working in tech writing or others involved in classes currently.
Hello! I am currently working in a environmental consultancy firm na and it involves a lot of writing reports. I am looking for someone who can help me to be a better writer and also proof read my written reports before submitting it to my boss. Message me so that we can discuss it further. :)
The company I received the offer from mentioned that I would be the first and only technical writer on their team. I'm confident in my technical background and my ability to communicate complex ideas through various forms of media, but I don't know where to start with regards to the actual publishing process.
Which tools do technical writers commonly use? How do these tools and processes differ with respect to the target audience - i.e. internal or external to the company?
Which resources did you find most helpful?
Any help would be greatly appreciated!!
Hi all,
I'm finding it difficult to appropriately write the "What Happened" and "Corrective Actions" in customer facing root cause analysis documentation. Leadership wants it direct and informational, while also being just vague enough to cover the company.
Looking for recommendations out there for online classroom style sessions that can assist with honing this skill. Thank you for your time!
Kevin
<rant>
I a beyond fed up. I've been trying to get a better job for the last five weeks or so. Taking Zoom interviews during lunch with my door closed, since of course half the office had to make everyone come back to the office and ended the mask mandate so everyone else has a cold already. WTF? Sorry to digress.
I have had interviews with about 20 organizations. Two five interviews, two with four, and several with three... Five asked for lengthy writing tests, and only one responded to me after I completed the work without me following up repeatedly.
One offered me a job for a little more, enough to make me jump ship from where I am. Five interviews, two tests, and now they want me to do six hours of technical training before I receive a penny.
How is this the new normal? Why does everyone claim that jobs are just being handed out with great pay and benefits? Why on earth should I do more work for free for a company I haven't even started at?
</rant>
Looking for some help from experienced technical writers on how to branch out from working for manufacturers. I see a lot of good-paying jobs available on the software documentation side of things, but I don't have much experience with this.
I'm currently employed as a contract technical writer for a medium-sized heavy equipment manufacturer in Canada. I recently received a full-time offer from the company. The salary on offer is... less than generous, and not much of a bump from the contract salary I was working for. The benefits and pension are excellent, but these aren't as important to me. This job, while pretty straightforward and enjoyable, is a bit of a dead-end, careerwise - once you're good at it, there isn't much more to learn here, and most people are unable to transition out of the technical writing role at this company. Opportunities for salary growth are limited, and inflation will eat up pretty much any pay increase.
What would you do to buff up your skills or branch out? What sort of jobs should I be looking for? I'm primarily interested in positioning myself to earn the largest salary possible - benefits aren't as important to me. This is my first year working as a technical writer, but I've gained a lot of experience with CAD illustration software, Arbortext, and using a content management system. I have a BA and a BSc, as well.
Hi there everyone, I'm a prospective technical writing/entry-level writer trying to crawl my way into the technical writing space. I am a new graduate (a degree in Creative Writing), with an internship sort of related to technical writing (A publishing/editing internship with a major literary agency), and some job experience in customer service via bookselling at Barnes and Noble (Christmas is truly frying my brain right now). I am struggling to break into the industry (I do live in a major city, though I don't know if the type of city matters), and because my brain doesn't work as a regular human, I'd like to inquire about the next possible steps. Should I be attempting to join the STC, and drop the money for the certificate? Should I be learning important skills like Madcap Flare and coding languages? Should I be eating living sea anemones? Please, any amount of direction would be super appreciated, and thank you again for all of your time.
More info here 👉 https://startwithnervos.com/webform/hashnode-x-nervos-writing-contest
https://preview.redd.it/25hqo0cf54681.png?width=1920&format=png&auto=webp&s=5be0223e65e4ebfc28b2a6f9e772ed4a162eec55
I had to move around some classes on my schedule due to needing to add an extra class which meant I had to remove my Technical Writing Class. I tried to get back into a Writing Class but I was put on the wait list. How likely is it to get into one of these classes when on the wait list? I really need to get into it in order to graduate next semester.
Hi guys, I’m a third-year English major with a concentration in Professional Writing. Due to my concentration, I’ve been in 3 tech writing classes where I’ve learned how to write how-to guides, instruction manuals, etc. Should I pick up a minor in computer science? Am I okay with just the English major and concentration? Also, what would be my next steps into getting into this field? Any advice really helps as I am very interested in these kinds of positions.
Hello,
I'm a couple years out of college with all my professional experience in the legal industry. I studied Classics in undergrad, and I'm in my first semester as a MBA student part-time. Over the last several months, I've had a resurgence of mind to pursue technical writing like I had following graduation, while living in Silicon Valley.
I've completed Technical Writer HQ certification course, researched about the industry online, and obtained a technical writing internship. I am now seeking to learn from you all how I can learn things like:
- Markdown
- API documentation
- contributing to projects on Github (how to work the platform, the upload, export, etc.)
- RoboHelp
- what content marketing systems are most used in which fields
I also would be so grateful to know the best way to ask someone to mentor me in this journey to land a technical writer role. As a person, I am committed to lifelong learning in my career. I'd love to learn from someone knowledgeable in technical writing.
Thank you!
Hi everyone!
I would like to get into technical writing, could any of you with any experience in the field point me to courses and resources you think would be valuable?
Thanks in advance.
Say you go to college and obtain a degree related to the field. How hard is it to get a well-paying technical writing job? By well-paying, I mean at least $45,000 a year.
Hi everyone!
I would like to get into technical writing, could any of you with any experience in the field point me to courses and resources you think would be valuable?
Thanks in advance.
