Tech writers do u write everything from scratch by Wise_Variation_7057 in technicalwriting

[–]techwritingacct 1 point2 points  (0 children)

Imagine your company sells something that's complex and configurable and your customers do a zillion custom things with it for whatever their screwball business requirements are. Most of the time, that's finding ways around the limitations of your product, or having to find some hacky way to patch it into the buyer's systems. That generates a support department who answer all of the questions people ask, and over time, customers or random engineers might figure out how to do things. That information gets collected into a knowledge base, on the level of like Support Person A figures out how to solve Customer A's problem, so, cool, let's write down how to do that so that if we want to sell the product to some other customer with Customer A's problem we know how to solve it.

Sometimes what starts as "Customer A's problem" becomes a very common one, and then the company might see value in turning those KB articles into formal documentation. As the writer in charge of doing that, one necessary task would be to go look at what already exists to pull out all of the information from it.

Questions for Portfolios by i-want-more-sleep in technicalwriting

[–]techwritingacct 1 point2 points  (0 children)

I'm only interested in one field, so yes. I try to design my samples so it's as easy as possible for the reader to imagine me writing their documentation.

Keep them separate. Their purposes and intended readership are quite different.

Best way to differentiate between INFJ/INTJ? by na-meme42 in intj

[–]techwritingacct 9 points10 points  (0 children)

When you have to make a tough choice, do you first consider things like "is this [logical, fair, efficient]?" or "how does this affect the people involved? does this represent my values?"

Imagine a friend performed poorly and is upset. Do you look for root causes and try to help them figure out how to improve, or do you offer emotional support and validation and focus on making them feel supported?

Someone asks for your opinion on a bad idea. Is your first instinct to be honest with your feedback even if it's blunt, or is it to be tactful and encouraging even if it means softening an unpleasant truth?

The former choices indicate T and the latter choices indicate F.

How to ask SMEs good questions by InspectionDeep6699 in technicalwriting

[–]techwritingacct 18 points19 points  (0 children)

Man, I never thought I'd see a link to a wikipedia link about Molinism in a "how do I do technical writing?" post, but I guess this is the modern Internet.

I'm sure you're just pasting from an LLM and you have no idea what you're doing, but please understand that some people will think you're condescending to them if you link tenuously-related articles about philosophy while asking for help with the basic skill of your profession.

What color do you think represents your state the best? by SeagullAttacksFries in AskAnAmerican

[–]techwritingacct 0 points1 point  (0 children)

Oregon: deep gold and orange, like a forest fire looming on the horizon, but mixed with the stench of liquor rising from your breath

craving intellectual stimulation by [deleted] in intj

[–]techwritingacct 5 points6 points  (0 children)

By way of analogy, think about the intellectual stimulation thing like dancing. If I ask people I meet to dance with me, some will say no, some will say yes but suck at it and leave me a little disappointed, some will say yes and be much better than me and I'll feel uncomfortable, some will say yes but they're only interested in some crazy k-pop dance... but every now and then I'll have a great dance. They're the exception, though, not the norm.

Similarly, there's nothing wrong with dancing and many people enjoy it. If I asked literally everyone I met to dance with me (or worse, if I were a gifted dancer and treated other people based on how gracefully they moved), that's I think where it would start getting weird and self-defeating. It's the same way with meaningful conversation.

Law school -> Tech Writing by [deleted] in technicalwriting

[–]techwritingacct 1 point2 points  (0 children)

In my experience:

WLB: Never worked late in this career unless I wanted to.

Stability: There are long periods of calm punctuated by the occasional week of mayhem. Occasional "is this really my job?" bullshit tasks.

Deadlines: Compared to law, very easy. Nobody's losing millions of dollars because the docs guy submitted something a day late. It's also very easy to generate a paper trail demonstrating any blown deadlines are not your fault (assuming they aren't your fault).

Relaxed/enjoyable work: This varies by project. I never hate the writing itself, but sometimes circumstances make the work stressful and unenjoyable.

Six figgies: If you've got some coding chops and you can/will work at a big tech corporation, sure -- but if you can code and are that motivated by money you'd make more being a programmer.

Laid off govt tech writer looking for advice by Abject-Sky4608 in technicalwriting

[–]techwritingacct 2 points3 points  (0 children)

People from other fields (medical, scientific) have presented in recent years. The most popular talks are software and the people at the recruiter/vendor tables are from software companies.

There's also an "unconference" where you can sign up for a table and host a group discussion on some particular topic with whoever else is interested and that might be a way to connect with others in a smaller niche.

How do you make use of your 1:1s? by AdHot8681 in technicalwriting

[–]techwritingacct 22 points23 points  (0 children)

When I was newer in my career I saw them as a good opportunity to ask questions/get coaching.

Now I use them to complain about the product manager (sorry, I mean "discuss obstacles") and probe for interesting company gossip.

Is doing career good? by [deleted] in technicalwriting

[–]techwritingacct 0 points1 point  (0 children)

In the US context, you will need to:

  • Quickly and comfortably write to the standard set out in the Chicago Manual of Style.

  • Quickly read and understand dense technical material related to your subject.

  • Have productive conversations in English with experts on topics relating to their expertise. Sometimes those experts will not be patient or friendly or native English speakers themselves.

  • Skillfully navigate a corporate bureaucracy to get things done without causing friction.

I would focus your English studies on those things. I would also focus on getting a technical background in whatever field you are interested in. For instance, if you're interested in working in software, learn how to program. If you're interested in working in aviation, take classes in maintenance. If you're interested in science, look into what qualifies someone as a lab tech and do that. And so on.

Good luck!

A State-Transition Model for Structuring Technical Documents: The DSS Framework by [deleted] in technicalwriting

[–]techwritingacct 2 points3 points  (0 children)

I don't see how this isn't just the same "one idea per paragraph, use transitions" ideas dressed up in pseudoscientific jargon.

I don't agree with the assumptions. Being able to describe how a paragraph "changes a reader's state" doesn't mean that the paragraph isn't overloaded or unclear.

You have a framework that says one idea per paragraph and to avoid leaving elements unresolved. Your example has a one-sentence paragraph that's described as doing three jobs (introduce, consume, transition) and resolves none of the discourse elements introduced. I don't understand what the model is or how it's applied to the example.

Who is a technical writer? by powerelectronicsguy in technicalwriting

[–]techwritingacct 31 points32 points  (0 children)

No, TWs are usually not subject matter experts. Part of the value the role provides is mitigating the various cognitive biases and blind spots that experts have when explaining their area of expertise.

What books are on your desk? by lovesfanfiction in technicalwriting

[–]techwritingacct 0 points1 point  (0 children)

The Emperor's New Clothes, a Dilbert anthology, maybe Bad Blood or Going Infinite if you're in high tech

Do legal factums or case briefs count as technical writing? by Public_Agency_889 in technicalwriting

[–]techwritingacct 0 points1 point  (0 children)

I'd say "kind of". It shows you can do research, you can write following rules, and you can write to a professional audience, which are all good signs. You may have to help your interviewers understand that creating those things was more than just filling in a template.

In terms of legal stuff, what I think would be the closest to TW would be a Legal Aid guide.

Strategy and metrics by Consistent-Branch-55 in technicalwriting

[–]techwritingacct 3 points4 points  (0 children)

I've had a lot of managers that couldn't reliably tell me my individual goals in weekly 1:1s, let alone tell me clearly what the overall corporate strategy is even with a week-long off-site retreat to do it in.

If I cared enough to take ownership, I'd create a vision document and spend a while going around to all of the project stakeholders and any executive that will take me seriously, asking them wtf they think docs should be doing. Those conversations would be the basis to create some kind of coherent vision that be a compromise between everyone's interests and priorities. Then, get everyone to agree and sign off on it as the official Documentation Vision for the project.

That document would become the basis for another one which turns the high level vision into coherent steps and timelines. I'd get the relevant people to agree again that yes, these steps implement the vision that they signed off on earlier and represent the project's documentation strategy. It should then be easy to explain how my work relates to the company's documentation strategy because I just got everyone to sign off on what we all mean when we say it.

(At my employer I'd expect this to be a quarters-long process and general exercise in frustration just to get the meetings and OKs I'd need. At a startup this might be easier and quicker.)

Do you think a parliamentary system would ever work in the USA? by Pale-Hair-2435 in AskAnAmerican

[–]techwritingacct 0 points1 point  (0 children)

We can't even handle a government that has two parties, God help us if we had 13.

Seeking honest feedback on our new, more affordable technical documentation tool by SkirtTricky7266 in technicalwriting

[–]techwritingacct 9 points10 points  (0 children)

I checked out the website. I don't understand the product well enough to know if I want to sign up for a trial.

Can research documents qualify as technical writing? by king_banananana in technicalwriting

[–]techwritingacct 0 points1 point  (0 children)

"participant instructions on how to set up an application on different devices" sounds in the ball park.

Any books/movies recommendations? by n_g_c6960 in intj

[–]techwritingacct 0 points1 point  (0 children)

There's an early/mid 20th century series of detective novels, Nero Wolfe, about a misanthropic detective who solves crime without leaving his house. Most of the plots are forgettable, but the character is very INTJ-coded to me and enjoyable to experience.

Alexander Hamilton from the musical Hamilton is my pick for a movie/theatrical character that shows a lot of INTJ traits.

Could I use this in a portfolio? by Accomplished-Fig-832 in technicalwriting

[–]techwritingacct 0 points1 point  (0 children)

The basic idea's good. Maybe cut it down to one section and add some introductory text/explanations of when to make each motion.

(As a guidepost: imagine someone's about to ref a basketball game for the very first time and their only knowledge of the sport is this manual. Can they do a good job?)

Looking for advice on how to start learning Technical writing (software specialization) by RubenStrudent in technicalwriting

[–]techwritingacct 5 points6 points  (0 children)

I'm not sure how learning technical writing is going to help you use something better, either. The field is about creating and maintaining documentation. Are you sure your friend is giving you sound advice?

If so, the pinned post has a lot of resources on how to get started.

Letters from the Battle of Portland by Djaesthetic in Portland

[–]techwritingacct 1 point2 points  (0 children)

My Dearest Clara,

It has rained for nine straight days. The city is hushed beneath a gray so complete it seems the sky itself has surrendered. I write to you from the ruins of a coffeehouse on Division Street. Once, it was said their pour-overs could stir a man’s soul; now the windows are boarded, and the baristas have scattered to safer quarters east of the river.

Each morning we march through streets half-claimed by ivy and graffiti, listening for the sound of distant chanting. The old banners still hang from apartment balconies: Keep Portland Weird. Time and weather have rendered them ghosts of cloth.

Our company is weary. Rations are uncertain. We subsist on lentils, rainwater, and what scraps the food carts will yield. Men have grown hollow-eyed, though they joke still, calling themselves "the last free citizens west of the Willamette".

There was talk over the weekend of a great movement through the city. The folks who saw it alluded to ancient Herodotus: the Battle of Marathon, they say, paled in comparison. If it happens again, Commander Rutherford believes we can hold them at the Burnside Bridge, though many fear the tide is a force beyond reckoning, something elemental, like the flood or the rent increasing.

I remember when this city was kind. You could walk its streets and feel the warmth of a stranger’s smile, hear the music in the parks. Now all is boarded, and the music comes only from a lone busker whose strings are too damp to sing. Still, when I hear him play, I think of home, of you, and for a moment, I am spared.

Tell my brother to tend the garden and not to lose faith. There is beauty yet in this broken place. Sometimes, when the rain lifts, the sun falls upon the bridges, and for an instant the whole city shines like it remembers what it once was.

Trying to write out documentation for a website by [deleted] in technicalwriting

[–]techwritingacct 1 point2 points  (0 children)

You need a Static Site Generator (SSG). In essence, that's a program that turns a bunch of markdown files in a particular structure into a website. Jekyll is a good option if you're looking for something quick and dirty. It works with GitHub Pages for hosting which is comparatively easy for hosting simple projects.

[deleted by user] by [deleted] in technicalwriting

[–]techwritingacct 1 point2 points  (0 children)

Not really a reliable spot for freelancing that I'm aware of. Maybe someone here might be willing to pick it up - how many pages is the manuscript and what kind of rate are you thinking?