No Esta Facil
  • 🌎About No Esta Facil
    • 👨‍💻GitHub
    • 📷Photography
    • 🗣️My Speaker Bio
    • 🤝Disclaimer
    • 📈Guilt Pile
      • Principal.dev
      • Tech Rocks Asia
  • 📚Book Reviews
    • Sports
      • Ben Hogan's Five Lessons
    • Productivity
      • Smart Brevity
      • Nine Lies About Work: A Freethinking Leader’s Guide to the Real World
      • Think Again
      • Mastery
      • Talk Like Ted
      • The Hard Thing About Hard Things
      • The Courage to Be Disliked by Fumitake Koga and Ichiro Kishimi
    • Classic Texts
      • The Book of five rings
    • Technology
      • Amplifying Your Effectiveness: A Gem in Professional Growth Literature
      • AI Superpowers: China, Silicon Valley, and the New World Order
      • The Age of Agile
    • Business
      • Start with No by Jim Camp
      • Zero to One: Notes on Startups, or How to Build the Future by Peter Thiel
    • Health, fitness, and dieting
      • Outlive
    • Culture
      • Solito by Javier Zamora
  • Daily Goods
    • Continuous Education
      • Expanding Your Vocabulary
    • 🌵Cultura
      • Food
        • BBQ’n Like a Pro: Rub Recipes for Pork, Brisket, and Chicken
        • The Ultimate Mashed Potatoes with Bacon and Roasted Garlic
  • 🏌️My Golf Journey
    • Teeing off at ...
      • Oaks Quarry Golf, Riverside, CA
      • Education City Golf Club, Qatar, Doha
      • The Links at Spanish Bay, Pebble Beach, CA
      • Bayonet, Seaside, CA
      • Alta Sierra Country Club, Grass Valley, CA
    • Training
  • 📝Monthly Highlights [in TL;DR format]
    • FY23
      • El Periódico - July 2023
      • El Periódico - December 2023
      • El Periódico - April 2023
      • El Periódico - March 2023
      • El Periódico - February 2023
      • El Periódico - January 2023
      • El Periódico - December 2022
    • FY24
      • January 2024
      • February 2024
      • March 2024
      • April 2024
    • FY25
  • 👨‍💻The section on Software Engineering
    • ChatGPT Prompts
      • Usages
        • What are some flutter architectures?
      • Prompt Templates
        • Answer Misconceptions
    • Conferences and Bootcamps
      • Google Cloud BootCamp
      • Principal Developer Masterclass
    • Customer Engagement
      • Awards - Customer Hero
    • Engineering Manager
      • Mobile Application Development
        • Flutter Journal
          • App Release Resources
        • Accelerate Your Go-to-Market Strategy with Flutter
      • Understanding the Meaning of Software Requirements
      • Design Principles
        • Coupling
        • Routine
        • Software Design
          • The Trinity of Software Architecture: Coupling, Cohesion, and Information Hiding
      • General
        • Engineering Meetings
          • Steering the Conversation: Effective Strategies for Keeping Meetings Focused and Productive
    • Project Owner
      • Project Pressure, It Happens!
      • Strategic Leadership and Planning
    • Software Engineering
      • Overview
      • Design Patterns
        • Categories of Design Patterns
        • Choosing the Right Design Pattern for Problem-Solving in Programming
        • Singleton
      • Programming Languages
        • JavaScript
      • Toolkits
        • iTerm2
        • Developing on a Windows 11 machine
          • Setting up Typscript env
        • VS Code Extension
        • HTTPie
      • Best Practices
        • Pull Requests (PR's)
    • Solutions Engineer
      • Communication with executives
      • SE Toolkit
        • The Importance of Retros in Integration Processes
        • Meetings
          • Preparing for a Customer Meeting (Project-Based or Recurring)
          • Conducting a Productive Customer Meeting
          • Prepare and Send a Concise and Actionable Meeting Summary
            • Meeting Summary Template
        • Documentation
          • Adding an important notes section
          • Useful Resources
  • 🛫Travel
    • Asia
      • Singapore
      • Japan
      • South Korea
      • China
      • India
    • Caribbean Sea
      • Cuba
    • Europe
      • North America
        • Mexico
          • Guadalajara
        • Canada
    • Oceania
      • Fiji
    • Middle East
      • Dubai
      • Qatar
    • South America
      • Brazil
      • Peru
      • Columbia
    • In the planning stage ...
      • Antarctica
      • Africa
Powered by GitBook
On this page
  1. The section on Software Engineering
  2. Solutions Engineer
  3. SE Toolkit
  4. Documentation

Useful Resources

PreviousAdding an important notes sectionNextAsia

Last updated 2 months ago

Topic
Description
Link

API's

Article on writing API documentation

👨‍💻
https://dev.to/theodoresummer/how-to-write-api-documentation-that-developers-love-in-2025-31aj