Do developers need code samples in API documentation?
https://idratherbewriting.com/blog/code-samples-might-not-be-needed-anymore
#APIDocumentation #TechWriting #CodeSamples #AI #DeveloperTools #SoftwareDocumentation #APIs #AIInTechWriting #DevDocs #TechnicalWriting #APIDocs #Coding #AIvsManual #SoftwareDevelopment
Writing Docs with Code Samples? Try Out the New Writerside EAP Release from JetBrains.
https://blog.jetbrains.com/writerside/2024/11/writing-docs-with-code-samples-try-out-the-new-writerside-eap-release/
#writing #documentation #docs #codesamples #contentdev #writerside #jetbrains
#AI #GenerativeAI #APIs #APIDocumentation #CodeSamples #Programming #SoftwareDevelopment #TechnicalWriting: "Providing code samples in documentation remains one of the most challenging aspects of API documentation. Even so, I’m optimistic about the helpfulness of AI tools to jump-start the process for tech writers. We can leverage code from test apps along with documentation, especially reference documentation, to provide starter code that engineers can then customize and adjust.
However, whether these basic code samples are helpful is another question. They might be mistaken for more valuable application code that would get into the deeper questions about how to design an application and handle the complexities of the developer’s specific business logic, along with questions about purpose, rationale, and design patterns."
https://idratherbewriting.com/ai/prompt-engineering-code-samples.html
OWASP also has projects with guidance - as in real code samples and not some of the garbage code samples we're seen from others...
Kudos to Bill for calling out garbage dev documentation with code snippets and no guidance. Good to see I'm not the only one who dislikes that!
