fn-mote 3 days ago

I guess you already know what a “Functional API” is and feel patronized. Also possibly you dislike the “cute analogy” factor.

I think this could be solved with an “assume the reader knows …” part of the prompt.

Definitely looks like ELI5 writing there, but many technical documents assume too much knowledge (especially implicit knowledge of the context) so even though I’m not a fan of this section either, I’m not so quick to dismiss it as having no value.

  • Retr0id 3 days ago

    I don't mind analogies if they actually convey some meaning, but this example just seems to be using it as an aesthetic flair.

[removed] 4 days ago
[deleted]
vivzkestrel 4 days ago

mind explaining what exactly was insufferable here?

  • Retr0id 3 days ago

    If you don't feel the same way from reading it, I'm not sure it can be explained.

    • stevedonovan 3 days ago

      I agree, it's hopelessly over-cheerful and tries to be cute. The pizza metaphor fell flat for me as well