Hacker News with Generative AI: Documentation

FFmpeg by Example (ffmpegbyexample.com)
FFmpeg By Example is a documentation website to showcase all the unique and different ways to use FFmpeg.
FFmpeg, Documentation, Video Editing, Multimedia, Software
877 points by piyushsthr 4 days ago | 244 comments
The Missing Nvidia GPU Glossary (modal.com)
We wrote this glossary to solve a problem we ran into working with GPUs here at Modal: the documentation is fragmented, making it difficult to connect concepts at different levels of the stack, like Streaming Multiprocessor Architecture, Compute Capability, and nvcc compiler flags.
Nvidia GPUs, Documentation, Glossary, Computer Hardware
227 points by birdculture 5 days ago | 70 comments
The Macros module is a fictitious module used to document macros (crystal-lang.org)
The Macros module is a fictitious module used to document macros and macro methods.
Programming Languages, Documentation, Crystal Language
12 points by benatkin 7 days ago | 3 comments
DoxyPress – Modern Doxygen (copperspice.com)
What is DoxyPress What is CopperSpice
Software, Documentation, Development Tools
33 points by jcbhmr 8 days ago | 11 comments
Documentation is more important than tests (anonel.substack.com)
Without the intention of making a click-bait-y title, I really think docs and tests are almost equal in importance, but if a company would only have resources to do one, they should choose documentation.
Software Development, Documentation, Testing
4 points by onel 9 days ago | 5 comments
The Seven-Action Documentation Model (passo.uno)
I think all technical writers, at some point or another, feel the urge to base their work on something more systematic than “it’s just the way folks documented stuff since forever”. Toolkits and frameworks provide content types, which is immensely valuable when you know what you want to write, but starting from there is like buying a hammer without knowing that half of the work you’ll do is turning screws.
Technical Writing, Documentation, Software Development, Frameworks
96 points by remoquete 9 days ago | 10 comments
Open source all the way down: Upgrading our developer documentation (cloudflare.com)
At Cloudflare, we treat developer content like a product, where we take the user and their feedback into consideration. We are constantly iterating, testing, analyzing, and refining content. Inspired by agile practices, treating developer content like an open source product means we approach our documentation the same way an open source software project is created and maintained.
Open Source, Developer Tools, Documentation, Software Development
4 points by emschwartz 9 days ago | 0 comments
Fast WYSIWYG tool for building and self-hosting professional documentation sites (tiledocs.com)
Create professional documentation websites with our no-code online editor
Documentation, Web Development, No-Code, Tools, Self-Hosting
4 points by aksuta_ipse 20 days ago | 0 comments
Why your team needs a Technical Writer to manage your documentation (momorell.com)
Technical Writing, Documentation, Software Development, Teams
9 points by mooreds 21 days ago | 1 comments
Microsoft rejects documentation PR because AI chatbots can't display tables (github.com/MicrosoftDocs)
Microsoft, AI, Documentation, Chatbots, Tables
108 points by panic 32 days ago | 30 comments
Documented and annotated source code for Elite on the Commodore 64 (github.com/markmoxon)
This repository contains the original source code for Elite on the Commodore 64, with every single line documented and (for the most part) explained.
Commodore 64, Retro Gaming, Source Code, Documentation
193 points by thunderbong 32 days ago | 54 comments
Jupyter Notebooks as E2E Tests (exotext.com)
Recently, I've been involved in building a new library, and it ended up containing a half dozen notebooks, covering everything from a quick start guide to niche applications and configuration examples. It being a completely new product, we wanted our users to have extensive interactive documentation from the start.
Jupyter Notebooks, Testing, Software Development, Documentation
81 points by freetonik 33 days ago | 38 comments
Tldr Pages (tldr.sh)
The tldr pages are a community effort to simplify the beloved man pages with practical examples.
Command Line, Documentation, Open Source
6 points by mrcsharp 34 days ago | 1 comments
Preferring throwaway code over design docs (softwaredoug.com)
Software Development, Code, Design, Documentation
327 points by softwaredoug 35 days ago | 172 comments
GPU Glossary (modal.com)
We wrote this glossary to solve a problem we ran into working with GPUs here at Modal : the documentation is fragmented, making it difficult to connect concepts at different levels of the stack, like Streaming Multiprocessor Architecture , Compute Capability , and nvcc compiler flags .
GPUs, Software, Documentation, Glossary
3 points by abhi9u 36 days ago | 0 comments
GPU Glossary (modal.com)
We wrote this glossary to solve a problem we ran into working with GPUs here at Modal : the documentation is fragmented, making it difficult to connect concepts at different levels of the stack, like Streaming Multiprocessor Architecture , Compute Capability , and nvcc compiler flags .
GPU, Glossary, Hardware, Computer Science, Documentation
15 points by iamwil 36 days ago | 1 comments
Show HN: Kubernetes Spec Explorer (kubespec.dev)
Find the documentation for all builtin resources, properties, types, and examples.
Kubernetes, Tools, Documentation, Open Source
216 points by goenning 37 days ago | 30 comments
GW-BASIC User's Guide (1987) (antonis.de)
Retro Computing, Programming Languages, History, Documentation
50 points by susam 41 days ago | 23 comments
Show HN: GitBook Documentation Downloader for LLMs (github.com/Amal-David)
A web application that converts Gitbook documentation into markdown format, optimized for use with Large Language Models (LLMs) like ChatGPT, Claude, and LLaMA.
Open Source, Documentation, Tools, Web Applications
7 points by amaldavid 42 days ago | 1 comments
We fixed our documentation with the Diátaxis framework (sequinstream.com)
Diátaxis recently made the front page of HN. I mentioned in a comment that we applied the framework to Sequin a couple weeks ago and were very happy with it. Some folks asked me to expand on my comment, so I'm doing so here:
Software, Documentation, Tools
61 points by _acco 43 days ago | 15 comments
Drawbacks and solutions for the Meilisearch document indexer (kerollmops.com)
Consider this post about the drawbacks and solutions for the Meilisearch document indexer. We'll start with the current situation, explore the techniques, and finally draft a powerful new document indexer.
Meilisearch, Search Indexing, Software Development, Documentation, Programming
45 points by ko_pivot 45 days ago | 8 comments
Ask HN: Product to improve monitoring and documentation: a good idea? (ycombinator.com)
Hi HN,<p>I have an idea for a product, but I want to test the waters before building anything.
Startups, Product Development, Software, Monitoring, Documentation
4 points by d--b 46 days ago | 5 comments
Show HN: Akiradocs – open-source Documentation Framework with AI features (github.com/Cloud-Code-AI)
AkiraDocs is a modern documentation platform that combines the power of AI with a Notion-like editing experience. Create, translate, and optimize your documentation automatically while maintaining complete control over the content. Perfect for teams who want to focus on their ideas rather than the complexities of documentation management.
Open Source, Documentation, AI, Software, Tools
22 points by sauravpanda 46 days ago | 3 comments
Your docs are your infrastructure (stackoverflow.blog)
Fabrizio Ferri-Benedetti, who spent many years as a technical writer for Splunk and New Relic, joins Ben and Ryan for a conversation about the evolving role of documentation in software development.
Technical Writing, Software Development, Documentation
25 points by runos 53 days ago | 18 comments
Creating Dynamic and Interactive Documentation for Visual Content (differ.blog)
Diagram-as-Code: Creating Dynamic and Interactive Documentation for Visual Content
Documentation, Visual Content, Software Development, Diagrams, Automation
9 points by thunderbong 57 days ago | 0 comments
Documentation Is Product (langfuse.com)
Today, on Day 4 of Langfuse Launch Week 2, we’re highlighting an often overlooked but critical element of great Developer Experience: Documentation.
Developer Experience, Documentation, Software
8 points by JannikM 57 days ago | 0 comments
Readme.so – Easy way to create a README (readme.so)
Our simple editor allows you to quickly add and customize all the sections you need for your project's readme
Software, Tools, Open Source, Documentation, GitHub
73 points by ahamez 63 days ago | 32 comments
C Gibberish to English (cdecl.org)
C, Programming, Tools, Documentation
66 points by warkanlock 67 days ago | 50 comments
MdBook – a command line tool to create books with Markdown (rust-lang.github.io)
mdBook is a command line tool to create books with Markdown. It is ideal for creating product or API documentation, tutorials, course materials or anything that requires a clean, easily navigable and customizable presentation.
Markdown, Documentation, Tools, Command Line
184 points by peter_d_sherman 68 days ago | 69 comments
Show HN: Java Markdown – living docs with Java code (reportmill.com)
SnapCode makes it fast and easy to start coding Java in any modern browser.
Java, Programming, Documentation, Web Development, Tools
4 points by jeffreportmill1 72 days ago | 0 comments