I am a CTO with over 5 years of experience in start-up and over 10 years in working at managing position for big companies. I am also a full-stacks developer with over 12 years in system design, product development and technology product deployment. User experience and system security are the things I care about most.
Documentation Libraries to Help You Write Good Docs
Good project documentation is key to success for every company, startup, or individual project. Without documentation, it’s much harder for new developers or others to use your project. In this article, I’ll discuss some of my favourite libraries you can use for building your documentation site. And don’t worry
Why creating a README has become my favorite part of development
And why it should be yours as well. Confession and Resolution My approach used to be total procrastination, and I would wait until the end of a project (if at all) to address documentation. By the end of any decent-sized project, I felt overwhelmed going back to the start of
A deep dive into TypeDoc’s workflow and extensibility
by Alexander Kamenov A deep dive into TypeDoc’s workflow and extensibility This topic aims to cover the basics on how you could extend the TypeDoc library functionality and what are the opportunities that it provides. For those of you who are not familiar with TypeDoc, this is a library which
We need a new document markup language — here is why
by Christian Neumanns We need a new document markup language — here is why Introduction: What’s the Problem? There are many document markup languages available already. Wikipedia lists over 70 variations in its List of document markup languages [https://en.wikipedia.org/wiki/List_of_document_markup_languages] — among them HTML, Markdown, Docbook, Asciidoctor, reStructuredText, etc. Why, then,
Why is so much enterprise documentation so awful?
I spend a very large portion of my professional workday reading through technology documentation. Perhaps “reading through” isn’t quite the right way to describe it. At this point, it’s more like quickly scanning menus, FAQs, and paragraph headings for clues to where I can find the exact piece of information
How to Write Accessible Technical Documentation – Best Practices with Examples
When you’re writing technical documentation for a project or a tool you’re working on, you’ll want it to be accessible. This means that it will cater to and be usable by the diverse global audience on the web. Web accessibility aims to make it possible for anyone to access web
How to Write Documentation For Your Next Software Development Project
Do you have a new software project on the horizon? You should prepare for success. The process of development determines the outcome. And a crucial part of making sure things run smoothly is having the right documentation in place. Before you start designing, coding, building, and testing, take the
What is a GitHub Wiki and How Do You Use it?
A GitHub wiki is a great place for your project’s documentation. You can use the wiki to create, manage, and host documentation for your repository so others can use and contribute to your project. GitHub wikis are easy to start using without installing any other software. The best part is