Nirdosh Gautamnirdoshgautam.dev·5 hours agoA Guide to Effective Go DocumentationIn this post, we’ll explore Go documentation, tools and techniques to make it effective, and ways to share it. What should be documented? Any exported type, function, constant, and variable become visible for public use, so they should be well docume...Discuss·26 readsGo Language
Mennatullah Diaamennatullah.hashnode.dev·Sep 29, 2023How can we safely utilize AI in technical writing?I am sure you are not here to read about the fact that generative AI is a double-edged sword. We all know it is, but how do we, as technical writers, make the best of it?Note: This article is not a guide nor will it contain out-of-the-box ideas on ho...Discuss·43 readsTechnical writing
Mauro GarciaforSpiroKit's blogblog.spirokit.com·Sep 26, 2023Announcing the new documentation portal for SpiroKit v2I'm happy to announce that the new documentation portal for SpiroKit v2 is finally ready. 🥳️ This includes almost 200 new stories with code snippets ready to copy and paste on your next app. If you have been using the previous docs portal, you'll n...Discuss·1 likeStorybook
Sm0keapp-generator.hashnode.dev·Sep 23, 2023[Debate] Reliable, long-run DOCS System - What options do we have ?!Hello Coders! DOCS are a very important part of any software product. Some projects use only a README, while others use PAID services like GitBook, ArcheBee, or opensource solutions (Docusaurus, MkDocs, Vuedoc ... etc) For all my projects, after a lo...Discussdocumentation
Arun Kumararunkumar0203.hashnode.dev·Sep 21, 2023Day 1: Mastering Git and GitHubIntroduction Welcome to the world of version control and collaborative development! Git and GitHub have revolutionized the way we manage code, collaborate with teams, and track changes in software projects. In this comprehensive guide, I will take yo...Discuss·2 likesGit
Bright Odohofrebrighto.hashnode.dev·Sep 21, 2023Markdown Essentials: A Beginner's GuideIn today's digital age, the need for proficient content creation is greater than ever. Markdown, a game-changer for web content, offers simplicity and accessibility. Markdown is here to simplify web document creation for developers, bloggers and writ...Discuss·1 like·27 readsmarkdown
Kevin WuforAirCodeaircode.hashnode.dev·Sep 20, 2023Add AI chat dialog to your VitePress documentation siteThis article will guide you how to quickly empower your VitePress documentation site with AI conversational capabilities using an open-source tool Documate. This will allow it to answer your users' questions based on the content of your documentation...Discuss·1 likeAI
Bekah Hawrot Weigelbekahhw.hashnode.dev·Sep 19, 2023The Role of Documentation in Open Source SuccessMaybe I’m biased because I spent ten years teaching college English before coming into tech. Or maybe it’s because I’ve seen projects fail because of poor documentation. Whatever the reason, I believe that documentation plays a huge role in the succe...DiscussOpen Source
Sarthak Jainblog.sarthakjdev.com·Sep 16, 2023Setting Up Documentation with Vitepress: A Developer's GuideIntroduction As a software developer, I've learned the importance of clear and well-organized project documentation. It not only helps you understand your codebase better but also assists your team members and contributors. In this blog, I will guide...Discuss·2 likesdocumentation
Sidharthan Chandrasekaran KamarajforThe Bug Shotsthebugshots.dev·Sep 15, 2023Moving from Azure Git Wiki to Vitepress: A Painless Journey to Speedy DocumentationIn the world of software development, documentation is often an overlooked yet crucial aspect of a project's success. At our company, we rely on Azure DevOps for software development, and one of the included packages is Azure Git Wiki. Initially, we ...DiscussDeveloper Toolsdocumentation
