davidbisset,
@davidbisset@phpc.social avatar

Interesting. Someone didn't like it when documentation uses the term "simply" and "it's easy" so much they made a site out of it:

https://justsimply.dev/

It's actually a GOOD site too, and if you write docs or marketing it might be worth a look.

elkarrde,
@elkarrde@ohai.social avatar

@davidbisset Ahh, that reminds me of the days when I had to use SBT - Simple Build Tool.
Yeah, "simple", sure. 😑

mirjam_diala,
@mirjam_diala@hachyderm.io avatar

@davidbisset That's great resource, thanks for sharing! I use the alexJS linter to flag that kind of language when I wrote documentation since I heard a talk about accessible documentation where that was mentioned! It was a big 💡moment for me - I worked hard on removing these phrases from my vocabulary when I still did dog training, but until the talk it didn't really click for me that it's also a good idea to do that in documentation and things like that 🤦‍♀️

baltasar,

@davidbisset @daniel very good. Indeed these are superfluous words that make text lengthy.

xinjinmeng,

@davidbisset

I'm not sure what "painfully easy" is, but if it persists for more than four hours, you should see a physician.

slyecho,
@slyecho@mdon.ee avatar

@davidbisset
Curl calls a big part of its API “easy”

nf3xn,
@nf3xn@mastodon.social avatar

deleted_by_author

  • Loading...
  • busycrying,

    @nf3xn @davidbisset the youtubification is real 😩

    jspath55,
    @jspath55@chaos.social avatar

    @davidbisset <Strunk and White enter the chat.>

    itsjoshbruce,
    @itsjoshbruce@phpc.social avatar
    shauna,
    @shauna@social.coop avatar

    @davidbisset For some reason I thought the site was going to be "input your docs url here and we'll show you ever time you've used the words 'just' 'simple' 'easy' and their variants" and now I'm sad it doesn't

    dartiss,
    @dartiss@mastodon.social avatar

    @davidbisset I've often thought of doing something similar for those who use the expression "the proof is in the pudding".

    seth,

    @davidbisset That's pretty and simple!

    jjcelery,

    @davidbisset this drives me nuts in documentation because it assumes a level of knowledge on par with the person who wrote the docs, which is rarely the case.

    What I love when I read docs is absence of justs and simplies, but instead something like "this doc assumes that you have some x knowledge and if you don't you may want to start at (link to x knowledge)"

    I try to do same when writing docs myself.

    kevinteljeur,
    @kevinteljeur@mastodon.online avatar

    @jjcelery @davidbisset @whalecoiner For what it’s worth, this makes technical books unreadable too, especially when it comes with a jaunty conversational style. Just give the facts, don’t tell me how easy it really is and that I’ll hopefully ‘get it’ later on.

    derickr,
    @derickr@phpc.social avatar

    @davidbisset My vim config highlights these words.

  • All
  • Subscribed
  • Moderated
  • Favorites
  • random
  • tacticalgear
  • DreamBathrooms
  • InstantRegret
  • magazineikmin
  • khanakhh
  • Youngstown
  • ngwrru68w68
  • slotface
  • everett
  • rosin
  • thenastyranch
  • kavyap
  • GTA5RPClips
  • cisconetworking
  • JUstTest
  • normalnudes
  • osvaldo12
  • ethstaker
  • mdbf
  • modclub
  • Durango
  • tester
  • provamag3
  • cubers
  • Leos
  • anitta
  • megavids
  • lostlight
  • All magazines