RStudio as a documentation tool for software development
February 12, 2018
RStudio as a documentation tool for software development
Score 9 out of 10
Vetted Review
Verified User
Overall Satisfaction with RStudio
We are software developers, not data scientists. We use RStudio for documentation. The .RMD pages allow us to document operational and development tasks with repeatable commands and/or scripts intermixed with explanations.
- Document BASH and build scripts written in various languages.
- Run Ad Hoc and initial SQL statements against our databases.
- Easily publish the .RMD documents as HTML or PDF files.
- Support for NodeJS and Javascript.
- Better examples and documentation regarding PanDoc.
- Saves us time when communicating complex setup procedures.
VSCode is our primary code editor. It also supports Markdown. If fact it has real time rendering of Markdown and HTML in side by side panes. While it has an excellent debugger, it does not have executable statement intermixed with descriptive test.
Using RStudio
| Pros | Cons |
|---|---|
Like to use Relatively simple Easy to use Technical support not required Well integrated Consistent Quick to learn Convenient Feel confident using Familiar | None |
- Mixing executable code with text explanations
- Generating and publishing HTML and PDF files from Markdown documentation
- There is no debugger. Support of BASH command is difficult.