search

kyyberi / 100daysofDX

One DX related post every day for 100 days. Written 14.7.-6.11.2019
https://100daysDX.com
Other
9 stars 2 forks source link

Documentation that makes you feel like you never left your editor (23) 5.8.2019 #42

Open agraebe opened 5 years ago

agraebe commented 5 years ago

Description

I'm in awe when I experience documentation that feels so familiar. Like I never left my editor. A great example is Stripe: https://stripe.com/docs/api

If you just start searching (simply hit '/'), you will know what I mean:

Screen Shot 2019-07-27 at 6 17 20 PM

I would love to discuss how current dev platforms make developers feel like they're home. In their own editor or CLI.

Readers should learn about most recent trends on documentation UX.

kyyberi commented 5 years ago

@agraebe How do you feel if this would go out Aug 5th? Then the branch would be "feature/day23".

agraebe commented 5 years ago

Let’s do it!