If anyone has an open source project and wants a review of their README and docs, please get in touch. I enjoy providing this type of feedback, and I think every project can benefit from it.
How I, a non-developer, read the tutorial you, a developer, wrote for me
301–310 of 455 posts
Re: How I, a non-developer, read the tutorial you, a developer, wrote for me
#302When I was at the head of the jailbroken iPhone ecosystem, I put together a tutorial for how to get an SSH daemon set up on their phones. I put a lot of effort into making it something that anyone could follow, step by step, and achieve the result, making sure to skip no steps, assume no knowledge, and with screenshots showing the interface. I soon thereafter received an e-mail from someone saying that they had excit…
Re: How I, a non-developer, read the tutorial you, a developer, wrote for me
#303As a developer, this is how I feel when I open a higher math textbook. Even though I understand that, in principle, mathematicians are using a syntax and lingo that shares some common features with computer code, my eyes slide over the words and symbols like they’re a foreign language.
Re: How I, a non-developer, read the tutorial you, a developer, wrote for me
#304This is primarily the reason why I stopped writing books and started making tutorial websites. There are so many interactive tools like element that can make tutorials accessible to more people without inflating the content itself. I'm still incredibly annoyed how constrained our web knowledge is to the feature set of ancient paper technology. We can click, hover, collapse areas, play videos and react to user actions…
Hello, I am just now trying to upgrade my blog. Can you please point me to sites that do this right?
Re: How I, a non-developer, read the tutorial you, a developer, wrote for me
#305Earlier quoted context omitted.
good job, you missed the point
Great job, you've failed to document the point.
Re: How I, a non-developer, read the tutorial you, a developer, wrote for me
#306Earlier quoted context omitted.
AVMetadataKeySpace A structure that defines a metadata key space. source: https://developer.apple.com/documentation/avfoundation/avmet...
That’s just a C enum interfaced in Swift. You can’t instantiate it, and it has no methods or any kind of functionality. It’s effective a list of numbers. What are you expecting the documentation to say here? It will make more sense when you find where it’s used. Edit: First link on the bottom explains exactly what it’s used for. https://developer.apple.com/documentation/avfoundation/retri...
Re: How I, a non-developer, read the tutorial you, a developer, wrote for me
#307This level of extreme hyperbole is silly and not in any way helpful. Try analyzing an actual tutorial (which will only be an analysis of that one--quality varies a lot).
Re: How I, a non-developer, read the tutorial you, a developer, wrote for me
#308Re: How I, a non-developer, read the tutorial you, a developer, wrote for me
#309This is such a good point. I've changed jobs a lot and one thing consistently bad (to varying degrees) is documentation and tutorials specifically. "Download X and setup" "It's not working..." "Oh yeah, you're supposed to do it on the remote access VM" "It says access denied" "Oh right, you're supposed to use the Yubikey for access" "I don't have a Yubikey, its pass + authenticator" "Ok, I'll email Jeff from this dep…
I've always this attitude that the one after me should not face the same issues as I had and so I update all wrong documentation, this also helps me remember how stuff works. But I have had many occasions where I just had to give up. People thought I was being annoying, my PR for fixed Readme (or even a Readme at all at times!) were simply not picked up, etc, etc. I left that company, and left a letter for management…
Re: How I, a non-developer, read the tutorial you, a developer, wrote for me
#310oh come on please it's easy just /etc/init.apt-get/frob-set-conf --arc=0 - +/lib/syn.${SETDCONPATH}.so.4.2 even my grandma can do that