Skip to content

Commit 7ad7678

Browse files
committed
Author API docs prompt - Correct author and ms.subservice guidance
1 parent 9a3c27a commit 7ad7678

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

.github/prompts/author-api-docs.prompt.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -233,8 +233,8 @@ For this scenario, the author should add these files to `temp-docstubs`:
233233

234234
### Additional prerequisites
235235
After gathering the inputs, you must also prompt the author to provide:
236-
- **author**: The value to use in the front matter `author` field across all new files
237-
- **ms.subservice**: The value to use in the front matter `ms.subservice` field across all new files
236+
- **author**: Value to replace TODO placeholders in the `author` field (only for new files or where TODO exists)
237+
- **ms.subservice**: Value to replace TODO placeholders in the `ms.subservice` field (only for new files or where TODO exists)
238238

239239
### Critical guidance on doc stubs
240240

@@ -947,9 +947,10 @@ When authoring or updating documentation, ensure compliance with these standards
947947
Before working on any file, apply these rules to both resource and API files:
948948

949949
### Front matter
950-
- **Replace TODO placeholders:**
951-
- Use the `author` value provided by the author
952-
- Use the `ms.subservice` value provided by the author
950+
- **Replace TODO placeholders only:**
951+
- If `author` field has TODO: replace with author-provided value
952+
- If `ms.subservice` field has TODO: replace with author-provided value
953+
- Do NOT update these fields if they already contain values
953954
- **[Optional] Improve the description:**
954955
- Make it user-friendly and clear
955956
- Use information from API.md to enhance it
@@ -958,6 +959,7 @@ Before working on any file, apply these rules to both resource and API files:
958959
- `ms.date`
959960
- `doc_type`
960961
- `ms.localizationpriority`
962+
- `author` and `ms.subservice` if already populated
961963

962964
### File body
963965
- **H1 title:** Leave unchanged

0 commit comments

Comments
 (0)