Woohoo! Got my Kotlin SDK docs PR tech review and the engineer approved with no comments. Guess I can write Kotlin code examples! #technicalWriting #techWriterLife

Got to do a couple of Information Architecture projects this week. I did an IA overhaul for one of our SDK doc sets last year, and it took me about 8 days. Now that I have a good model to follow, I did two more in less than a day each this week.

It’s just wild how much more discoverable information becomes with a good IA. I love making improvements like this.

#techwriting #techWriterLife

Woohoo! Someone closed an issue in our product’s GitHub repository because someone else posted about finding “a working example in the documentation” and then explaining the solution to the OP.

I put that doc page together 😁

I love it when docs work and are helpful!

(And I love it even more when other people share them!)

#technicalWriting #techWriterLife #documentation

Whenever I say things like, "It's important to make the doc useful on mobile devices because sometimes people want to read docs on the train."

You should just s/train/toilet/

#techWriterLife #techWriting

Version numbers are STRINGS not DECIMALS.

Version numbers look like decimals, but they're not.

The version after 2.9 is 2.10, which is not the same as version 2.1

#theMoreYouKnow #techWriterLife

Writing documentation is easy.
Maintaining documentation is hard.

#techWriting #techWriterLife

Do you know how many different models have a property named "status"?

Almost all of them.

When you design a model, please try to make your property names NOT generic or ambiguous. (See "title")

#techWriting #techWriterLife #documentation

Pro tip for @drafts users:

You may want to keep your "Post to Mastodon" actions in an isolated group so you don't accidentally post internal meeting notes to the fediverse.

#techWriting #techWriterLife

Is there a #mastodon instance that houses #technicalWriters?

I'd like to be on an instance where the local feed is interesting on its own.

#techWriterLife #techWriting #writeTheDocs #documentation

Is there a #mastodon instance that houses #technicalWriters?

I'd like to be on an instance where the local feed is interesting on its own.

#techWriterLife #techWriting #writeTheDocs #documentation

"You should say what the max and min are, and also all the error conditions."

'Great idea! What _are_ the max and min? What are the error conditions?'

"Uhm, I don't know."

'Didn't you write this method?'

"Yes. What does that have to do with anything?"

'🤦‍♂️'

#techwriting #techwriterLife

"You should say what the max and min are, and also all the error conditions."

'Great idea! What _are_ the max and min? What are the error conditions?'

"Uhm, I don't know."

'Didn't you write this method?'

"Yes. What does that have to do with anything?"

'🤦‍♂️'

#techwriting #techwriterLife

Came across this little gem when cleaning out the basement tech lab. Note the “Internet” contact.😂😥

#ComputerGamingWorld #TechWriterLife