kili-blogger-program icon indicating copy to clipboard operation
kili-blogger-program copied to clipboard

Improve your productivity by using Markdown and VSCode as 1 of your documentation tools.

Open fvgm-spec opened this issue 6 months ago • 0 comments

Abstract

Productivity is the key to success in this wide field of software development, and one of the fundamentals of a good software project is documentation. This is why having effective tools and strategies that help us stay organized and efficient is always worth it. In the next sections of this tutorial, we will explore the history that is behind Markdown, its benefits, best practices you must follow, pros and cons, and challenges faced when implementing and maintaining good documentation in our software projects.

Outline:

  • Markdown history [Some content related to how and who brought Markdown to our lives]
  • Incorporating VSCode into your writing routine [This part of the article will teach the readers how to set their environment to work with VSCode, not being afraid to code!]
  • Configuring a Version Control flow in your project [This section should include the steps that users will follow to set their version control system into their writing process]
  • Discovery of how Git works [This section will introduce readers new to Git, what is the philosophy behind the idea of controlling the versions of their files]
  • Practical case: Building your documented project from scratch [In this part the reader will deeply understand in a practical way how to build technical documentation on the shoulders of a version control system and Markdown files]
  • Conclusion

My content is

  • [ ] A Kili Tutorial / Guide / How to article
  • [x ] An Article

fvgm-spec avatar Dec 10 '23 21:12 fvgm-spec