Documenting with Markdown

Rik Scarborough Development Technologies, Programming Leave a Comment

In today’s environment, we have an embarrassment of riches when it comes to documenting our applications. We have a multitude of word processors, websites with word processors built in, wikis, and notes applications galore.

So you may be wondering, is there even any point in talking about ways to document your application? I think there is. In this blog, I’ll share my documentation tool and how and why you can use it in your own projects. It’s called Markdown.

Documentation: Enough Already! Not.

Mike McCoy Consulting, Programming, Soft Skills Leave a Comment

Documentation. I know we all hate having to create it. I don’t like writing it and feel like I always leave something out. However, our assumptions of what other developers should think we are trying to accomplish by our masterpieces of software are usually filled with potholes (sometimes big ones). The truth of the matter is that no matter how stellar your code or software is – if you’re the only one who understands how it works, it doesn’t do any good.

These are not paintings or sculptures that would live the rest of their days in a museum, untouched by human hands and just collecting dust as they run. In reality, documentation will be added to and changed as the information they describe evolves.

In this blog, we discuss two suggested strategies for the creation of useful and concise software documentation.

Angular and Swagger: Experiences Learned

RJ Dela-Cruz Angular, Development Technologies, JavaScript 1 Comment

Recently I was fortunate enough to be a part of a project where we were building an application from scratch into an Angular front-end application with Microservices in the back end. Swagger was used as the contract between the UI and Microservices.

In this blog, I talk about the things I learned from this project experience, like how to use Swagger to define the endpoints of the Microservices, integrating Swagger-generated code into Angular, and working with configuration (including oAuth2 tokens), among other “gotchas…”

Give Enterprise APIs Visibility With Swagger And GrokOla

Lauren Fournier Company News, Keyhole Creations Leave a Comment

Attention: The following article was published over 6 years ago, and the information provided may be aged or outdated. Please keep that in mind as you read the post.The Keyhole Labs team is excited to announce that GrokOla now offers Swagger integration. GrokOla users can now upload Swagger JSON files into GrokOla to have all API documentation centralized, searchable, and accessible …

What They Didn’t Teach Me In College

Robert Rice Programming Leave a Comment

Attention: The following article was published over 8 years ago, and the information provided may be aged or outdated. Please keep that in mind as you read the post.I attained my IT degree (B. S. in Computer Science) 12+ years ago at a traditional midwestern college, so the education was fairly well rounded. Looking back more than a decade later …