2025

A Brief History of APIs

Application Programming Interfaces (APIs) have evolved since their inception in 1968, transitioning from a simple interaction model between graphics programs and computers to vital tools in software development today. They facilitate communication between front-end applications and back-end systems, available as public or private APIs. Major protocols include REST, SOAP, RPC, and GraphQL, while best practices for API design promote flexibility, security, and efficiency.

A Brief History of APIs Read More »

Header image with the words seo optimization at the top and an AI depiction of Google Search with clouds in the background

Get SEO Optimization Tips and Advice for your Website

Building a successful business today requires an online presence that potential customers can find when needed. Thismeans building a website and blog that will appear in Google search results. The ultimate is to make it onto the first page, which is the first ten listings for a keyword combination.  Understanding SEO Optimization Advice: A one-word keyword shouldn’t be used because it’s

Get SEO Optimization Tips and Advice for your Website Read More »

An old desktop computer on a desk with a keyboard and the terminal app on the screen. Behind are several frames.

Prompt Engineering 3: Editing

This content discusses the use of chatbots, particularly Microsoft’s Copilot, for editing command-line interface (CLI) documentation. It emphasizes the importance of using feedback and iterative editing to improve clarity and organization. The post details a practical example using Python’s docopt, showcasing how to create effective CLI documentation through clear steps and targeted edits.

Prompt Engineering 3: Editing Read More »

AI Generated image of books about the command line against the wall with a sight containing 'Create CLI Help Docs'.

Using Docopt to Create CLI Documentation

This post demonstrates the use of Docopt in Python for creating user-friendly command-line interface (CLI) documentation. It covers the installation steps, importation, and integration of help documentation into a reverse string function. The final implementation enhances usability and promotes better code quality while highlighting the importance of comprehensive documentation.

Using Docopt to Create CLI Documentation Read More »

Conducting research with a chatbot

Prompt Engineering 2: Conducting Research

This post details the process of creating command-line interface (CLI) documentation using various tools. It emphasizes the necessity of initial research with chatbots, followed by brainstorming to identify specific tools like docopt, Click, and Commander.js. A thorough dive into docopt demonstrates its documentation-first approach, showcasing usage examples and options.

Prompt Engineering 2: Conducting Research Read More »

Composing prompts for chatbots

Prompt Engineering 1: Composing Prompts

This post outlines an introduction to crafting prompts for five popular chatbots, emphasizing different levels: simple (1-3 instructions), complex (3-5), and hypercomplex (5+). It details how to construct effective prompts using Microsoft’s Copilot, showcasing examples on various topics. The conclusion provides guidance on utilizing chatbots for technical writing projects.

Prompt Engineering 1: Composing Prompts Read More »

Scroll to Top