adithya-s-k / adithya-s-k/AI-Engineering.academy

[DOCS] Structural Redundancy and Duplicate Sections in “Advanced Prompting Techniques” Page

未關閉
#27 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
documentation
主要語言
Jupyter Notebook
星號
2.4k
分支
280
PR 合併指標
30 天內沒有已合併 PR

描述

## Documentation Page
Advanced Prompting Techniques: A Comprehensive Guide
```
docs/PromptEngineering/Advanced_Prompting.md
```

## Improvement Needed
The page contains multiple instances of duplicated sections and repeated conceptual explanations under different headings. This creates structural redundancy, increases document length unnecessarily, and may confuse learners into thinking repeated sections describe distinct techniques.

The redundancy appears in the following exact sections:

### 1. Duplicate: “Chain of Thought” and Later “Chain-of-Thought”

First occurrence: `## Chain of Thought`
Includes:
- “Understanding CoT”
- “Practical Example”
- “Advanced Usage: CoT Rollouts”

Inside “Advanced Usage: CoT Rollouts,” the following concepts are explained:
- Self-consistency decoding
- Complexity-based evaluation
- Human validation integration

Second occurrence (later in page): `## Chain-of-Thought`
This section again explains:
- CoT rollouts
- Self-consistency decoding
- Complexity-based prompting
- Human intervention
- Improved accuracy

These topics substantially overlap with the earlier “Advanced Usage: CoT Rollouts” subsection. The second section repeats the same conceptual content rather than introducing new material.

### 2. Duplicate: “ReAct Prompting” and “ReAct Prompting Illustrated”

First occurrence: `## ReAct Prompting`
Includes:
- Definition of ReAct (Reasoning and Acting)
- Explanation of Thought / Action / Observation
- Comprehensive example (highest-grossing film of 2009)
- Applications list

Second occurrence (later in page): `## ReAct Prompting Illustrated`
Includes:
- Definition of ReAct
- Explanation of Thought / Action / Observation
- A full worked example (Eiffel Tower - Capital of France)
- Applications list

Both sections:
- Explain the same framework structure
- Provide similar step-by-step examples
- List similar applications

The second section rephrases and expands on the first rather than introducing a new variation or advanced concept.

### 3. Duplicate: “Directional-Stimulus Prompting” (Appears Twice)

First occurrence: `## Directional-Stimulus Prompting`
Includes:
- Definition of DSP
- Use of small policy model (e.g., T5)
- Supervised fine-tuning
- Reinforcement learning
- 41.4% improvement on MultiWOZ dataset
- 80 dialogues reference

Second occurrence (later in page): `## Directional-Stimulus Prompting`
This later section again includes:
- Definition of DSP
- Use of small tunable policy model (e.g., T5)
- Supervised fine-tuning and reinforcement learning
- 41.4% MultiWOZ improvement
- 80 dialogue reference

The second section repeats nearly identical technical details and performance metrics without adding new insights.

### 4. Duplicate: “Generated Knowledge” and “Generated Knowledge Prompting”

First occurrence: `## Generated Knowledge`
Includes:
- Knowledge Generation Phase
- Knowledge Integration Phase
- Benefits list

Second occurrence (later in page): `## Generated Knowledge Prompting`
Includes:
- Explanation of two-step process (knowledge generation + integration)
- Benefits (improved accuracy, contextual grounding)
- Similar reasoning explanation

The later section repeats the same conceptual explanation already covered in the earlier section.

## Structural Impact

- Redundant sections increase cognitive load for learners.
- It may create confusion about whether repeated sections represent different techniques.
- It reduces structural clarity.
- It makes future maintenance more difficult, as updates must be made in multiple duplicated areas.

## Suggested Content

1. Merge duplicated sections:
- Combine both “Chain of Thought” and later “Chain-of-Thought” into one unified section.
- Keep “CoT Rollouts” as a clearly labeled advanced subsection under it.
- Merge “ReAct Prompting” and “ReAct Prompting Illustrated” into one section containing:
+ Framework explanation
+ One or two examples (without repeating conceptual definitions)
- Merge both “Directional-Stimulus Prompting” sections into one consolidated technical explanation.
- Merge both “Generated Knowledge” sections into a single structured explanation.

2. Standardize Structure Across Techniques:
- For each technique, use consistent subsections:
+ Definition
+ Core Components
+ Example
+ Applications / Benefits

3. Remove Repeated Explanatory Language
- Avoid reintroducing definitions already fully explained earlier unless expanding meaningfully.

4. Optional Improvement
- Add a comparison table summarizing:
+ Technique
+ Core idea
+ Best use case
+ Level of complexity

## Screenshots or Examples

Below is a comparison of duplicated sections appearing earlier and later in the document.


Early Section
Later Section



Image


## Chain of Thought


Image


## Chain-of-Thought



Image


## ReAct Prompting


Image


## ReAct Prompting Illustrated



Image


## Directional-Stimulus Prompting


Image


## Directional-Stimulus Prompting (Repeated)



Image


## Generated Knowledge


Image


## Generated Knowledge Prompting

## Additional Context
The content itself is accurate and well-written. The issue is structural rather than factual. I would be happy to assist with restructuring or submitting a PR that merges the duplicated sections into a cleaner, non-redundant format.

貢獻指南

開啟貢獻指南

評估

這個 Issue 還沒有評估資料。

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。