Writing Advise

An act that you do with your heart

sky-blue-writting

Depending of the document type you will need to figure how to start. If you barely have an idea of how it should look, search for references.


Topics:

Who are you writing this for?

Review

Is easier to spot a bad movie than to point what it does good. And if you do, you will end up with a bunch of cliches.

What to Look for

We tend to miss a lot of information when we write because we skip the obvious stuff to keep things simple, which isn’t necessarily bad.

Here are some tips:

What to Avoid

AIs and ChatGPT

As you may already know (I hope so), in a company you should avoid use this service. If you do because “insert the proper reason here,” at least don’t do it carelessly; exposing sensitive information by passing a whole document just to rewrite two lines of text would be very questionable.

To put it simply, if someone asks how they’re doing and they respond with a lengthy explanation about the current geopolitical and economic situation before getting into business, it might come across as odd and pretentious. The same principle applies to documents; sometimes, less is more.

Prompts

Let’s say I want to write a quick context for a document that delves deeper into the Cold Start issue affecting Lambdas inside VPCs. A simple answer would be, “Lambdas that run on VPCs are not fast because the allocation of internal resources is slower than public ones that are always ready to be executed.”

But let’s give it a try with ChatGPT (ChatGPT 3.5) with slightly different prompts:

If you will have to go through a lot of filler to get to the essential notions of the document, that’s no good; if you want to go deeper into a topic, that’s fine, but be aware of who you are writing for. Is it a “From Zero to Hero” course or just a document providing clarity and guidance over a topic you would likely read in a pinch?

We don’t want you to go into Prompt Engineering to write a summary you could otherwise come up with while trying to get the correct output. A few things that you consider are:

If you only need a grammar check, use Grammarly; you only have to pay for it. I think it’s worth every penny for the time saved in proofreading. I also find the capability to rewrite certain pieces or suggest options and ideas quite handy.

Advice for the Young at Heart

Adding more text won’t necessarily improve your document; it might make reading overly complicated. ChatGPT typically aims to meet a specific character count to sound informative and engaging, but it’s crucial to maintain clarity and conciseness above everything else.

ChatGPT is helpful, but it is like using Mahoraga. Depends on how you use it.