When #LLM generates #API #documentation is that detailed and still so much on point, that you start to wonder, if you accidentally gave the AI some code you don't want to share.
You search the chat and don't find this very function.
#Paranoia arises: "Who is watching me!?"
You inspect the chat more thoroughly and find an interface function that calls the "secret" function, but also provides the variable names to justify the LLM's excellent API docs.
Puh, that was close.
Công cụ eGlue biến tài liệu API thành bản tích hợp sẵn! Điều này có thể giải quyết được vấn đề hay không? Hãy cho ý kiến về công cụ này! #eGlue #APIDocs #Integration #PhầnMềm #CôngCụ #TíchHợp #Th詢FINE #Api #TựĐộngHóa
Công cụ eGlue: Tự động tạo tích hợp API từ tài liệu. Xem demo và đóng góp ý kiến! #eGlue #APIDocs #TíchHợpAPI #CôngCụPhátTriển #DeveloperTool #PhátTriểnPhầnMềm
Công cụ AI DocUnpack giúp đơn giản hóa tài liệu API phức tạp! Jetzt có bản dùng thử miễn phí, cơ bản và chuyên nghiệp. #AIDocUnpack #APIDocs #SimplifyingTech #CôngCụAIDevelop #TàiLiệuAPI #TechNews #TinCongNghe
https://www.reddit.com/r/SaaS/comments/1oprds7/i_built_an_ai_that_simplifies_confusing_api_docs/
Api documentation: Codeberg pages can point to repository/@branch/subdir/stuff.html . So I started with having a documentation directory as part of the source code.
Somewhat awkward, though, to mix commits with tons of doc files witch small code change commits.
Solution: a "docs" repository with a subdirectory for each project. Its commits will also have loads of files, but not mixed in between code changes. Nice.
🚀 SuCoS v6.2.0 drops with game-changing API documentation! Generate beautiful C# API docs with a single command: `sucos api --project <PATH>`. Zero config, familiar templates, faster than DocFx!
See it live: https://sucos.brunomassa.com/api
🚀 Behold, the revolutionary 'Claude Code' – the command line tool you'll pretend to use to impress your friends while still googling "how to use command line" 🤓. For an astonishingly fair price, it promises to automate your job while you’re busy scrolling API docs written in every language except Klingon. 🛠️💤
https://support.anthropic.com/en/articles/11145838-using-claude-code-with-your-max-plan #ClaudeCode #CommandLine #Automation #TechHumor #DeveloperTools #APIDocs #HackerNews #ngated
🚀 New Release: API-Doc-Crafter just got sharper. Cleaner. Meaner.
Giving my little OpenAPI merging monster some upgrades.
It all started with a simple idea: merge OpenAPI specs from multiple repos.
Now? It transforms outdated Swagger specs to OpenAPI 3+, generates HTML pages with full navigation, and allows customization via config or env.
✨ SecurityRequirement deduplication - because why merge APIs if you can't also merge logic?
🧠 Custom metadata enrichment - inject your info, license, contact, and docs straight from config. No more excuses.
🔁 Better parser fallback - now tries more ways to read broken specs than your average intern in panic mode.
🎭 Variable substitution in outputs - ${variables} be gone. Use env or config, stay DRY, stay sane.
🧪 Tests expanded. HTML, JSON, YAML outputs covered like a nuclear bunker.
🧰 Powered by GraalVM, no reflection, blazing fast.
🐳 Native Docker builds.
🧼 Reflection config surgically trimmed. Less bloat. More edge.
Project: https://github.com/YunaBraska/api-doc-crafter
Happy crafting. And remember: if your docs aren't automated, they're probably lies.
#OpenAPI #Swagger #APIdocumentation #DevTools #GraalVM #Java21 #Docker #Automation #CleanCode #DevLife #APIDocs #OpenSource #DeveloperTools #coding #programming
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
🛠️ Api-Doc-Crafter - Last-minute release before 2025! 🎆
lightweight tool (CLI, Docker, GitHub Action) to merge, sanitize, & generate API docs with ease! Built for Developer Experience, Minimalism, & Compliance.
🧩 Merge OpenAPI/Swagger files effortlessly.
🔒 Exclude sensitive endpoints with patterns.
🌐 Whitelabel HTML output
📁 YAML, JSON, & HTML support.
⚡ Blazing fast & portable.
🖌️ Add your own logo & branding.
Just wrapped up my talk at #APIdays Paris!
🚀 Built a wild GenAI tool that turns messy inputs into killer API docs using @Mistral + @HuggingFace.
Turning raw notes & specs into structured documentation? Yes, please.
🔗Demo: https://apidays-ai-novikova.netlify.app/documentation
🖥️ Slides: https://speakerdeck.com/lananovikova10/beyond-the-spec-bringing-context-to-life-with-genai-for-api-docs
📦 Code: https://github.com/lananovikova10/apidays-ai-poc
#AIDocumentation #APIDocs #generativeAI
Docs as Code: The Best Guide for Technical Writers
"Docs as Code is a methodology where documentation is treated like code. This means you use the same tools and processes for documentation that you use for code development. By doing this, you integrate documentation into the development process, making it a first-class citizen." -- #DumebiOkolo
Let’s Bring Science Into API Documentation
https://blog.jetbrains.com/writerside/2024/06/let-s-bring-science-into-api-documentation/
"Just like the knowledge of wave patterns enhances a surfer’s performance, understanding the principles of pattern recognition and learning styles can transform our approach to API documentation." -- #SvetlanaNovikova
API Documentation Checklist
https://bump.sh/blog/api-documentation-checklist
"This article provides a checklist to help you identify the documentation you will need for launching your API. We will also include some things to consider post-launch as well to help you continue to improve your documentation." -- #JamesHigginbotham
Moving API Docs From Human-Readable to Machine-Readable https://buff.ly/3TPK2KV
"I have more faith that we will get humans to adopt or at least auto-generate OpenAPI and APIs.json than I believe we’ll develop AI to unwind this mess." -- #KinLane
Everyone is looking to me for API doc best practices and process. Validating, but also a little intimidating, like the teacher learning the content the night before to stay ahead of the API doc class while teaching seven other classes at the same time.
I'd appreciate y'all sharing any thoughts & references & resources, from theory to implementation.
#technicalWriting #techWriterLife #writeTheDocs #loneWriter #apiDoc #apiDocs #apiDocumentation
Making good API docs is vital, and I enjoyed this post from Infobip showing how good API design and description are part of what makes good docs
https://www.infobip.com/developers/blog/the-must-have-content-to-include-in-your-api
#APIdocs #OpenAPI #linkTuesday
#APIdocs do not have to be boring!
You can enhance how you describe and document the concepts in your #API with cool images 🖼️
If yours is based on #OpenAPI or #AsyncAPI, you can now perfectly size them 📐 on https://bump.sh/
