techdoc/src/md/research.js

a cli tool to generate documentation for developers, users, and others also.

const research_sm = () => {
    let md = `
# Research on Topic

🔍📚 Welcome to our research document! In this document, we compile information and findings on the topic of [insert topic]. Feel free to explore and contribute to our collective knowledge.

## Table of Contents

- [Introduction](#introduction)
- [Key Concepts](#key-concepts)
- [Research Methodology](#research-methodology)
- [Findings](#findings)
- [Conclusion](#conclusion)

## Introduction

Provide a brief introduction to the research topic, outlining its significance and the purpose of the document.

## Key Concepts

Highlight key concepts related to the topic that readers should understand before delving into the research findings.

## Research Methodology

Briefly describe the methodology used for conducting the research, including sources, data collection methods, and analysis techniques.

## Findings

Summarize the main findings of the research. Use clear sections or bullet points to organize the information logically.

## Conclusion

Conclude the document by summarizing the key takeaways from the research and any implications for further exploration.    
`
    return md
}

const research_md = () => {
    let md = `
# Research on Topic

🔍📚 Welcome to our comprehensive research document! In this document, we delve deep into the topic of [insert topic], presenting key concepts, detailed research methodology, and extensive findings. Your contributions are valuable to enrich our collective knowledge.

## Table of Contents

- [Introduction](#introduction)
- [Key Concepts](#key-concepts)
- [Research Methodology](#research-methodology)
- [Literature Review](#literature-review)
- [Data Analysis](#data-analysis)
- [Findings](#findings)
- [Conclusion](#conclusion)

## Introduction

Provide a thorough introduction to the research topic, outlining its historical context, relevance, and the objectives of the document.

## Key Concepts

Examine and explain key concepts related to the topic, ensuring readers have a solid understanding before delving into the research findings.

## Research Methodology

Present a detailed overview of the research methodology, including the selection of sources, data collection methods, and the analytical approach employed.

## Literature Review

Explore existing literature relevant to the research topic, summarizing key theories, studies, and insights from authoritative sources.

## Data Analysis

If applicable, provide a detailed analysis of collected data, presenting charts, graphs, or any visual aids to enhance understanding.

## Findings

Organize and present the main findings of the research, categorizing information logically and providing insights derived from the analysis.

## Conclusion

Conclude the document with a comprehensive summary of the research, highlighting significant findings and suggesting potential avenues for future exploration.    
`
    return md
}

const research_lg = () => {
    let md = `
# Comprehensive Research on Topic

🔍📚 Welcome to our exhaustive research document! In this comprehensive exploration of the topic [insert topic], we aim to provide a thorough understanding of key concepts, detailed insights into our research methodology, an extensive literature review, nuanced data analysis, and a profound discussion of our findings. Your contributions are encouraged to enrich our collective knowledge.

## Table of Contents

- [Introduction](#introduction)
- [Background](#background)
- [Objectives](#objectives)
- [Key Concepts and Definitions](#key-concepts-and-definitions)
- [Research Methodology](#research-methodology)
- [Literature Review](#literature-review)
- [Data Collection and Analysis](#data-collection-and-analysis)
- [Findings and Interpretations](#findings-and-interpretations)
- [Conclusion and Recommendations](#conclusion-and-recommendations)

## Introduction

Provide a comprehensive introduction to the research topic, contextualizing it within broader themes and establishing the document's objectives.

## Background

Delve into the historical background of the research topic, highlighting key developments and the evolution of relevant concepts.

## Objectives

Clearly state the objectives of the research, outlining the questions or challenges the document aims to address.

## Key Concepts and Definitions

Provide an extensive exploration of key concepts related to the topic, defining terms and ensuring readers have a robust foundation.

## Research Methodology

Present a detailed overview of the research methodology, covering the selection of sources, data collection methods, and the analytical framework employed.

## Literature Review

Conduct a thorough literature review, synthesizing existing knowledge, summarizing relevant studies, and identifying gaps in the current understanding of the topic.

## Data Collection and Analysis

If applicable, detail the process of data collection, present methodologies for analysis, and showcase any visual representations of the data.

## Findings and Interpretations

Organize and present the main findings of the research, providing in-depth interpretations and insights derived from the analysis.

## Conclusion and Recommendations

Conclude the document with a comprehensive summary of the research, emphasizing key findings and offering recommendations for future exploration and application.    
`; return md
}

module.exports = {research_lg,research_md,research_sm}