documentation
Генерация документации для TypeScript кода
또한 다음에서 사용할 수 있습니다: Joseph OBrien,BfdCampos,Joseph OBrien,DaoThiHuong2111
Написание документации отнимает время от программирования. Этот навык предоставляет экспертные шаблоны для TSDoc комментариев, Storybook историй, VitePress руководств и TypeDoc API справочников, чтобы вы могли документировать быстрее.
스킬 ZIP 다운로드
Claude에서 업로드
설정 → 기능 → 스킬 → 스킬 업로드로 이동
토글을 켜고 사용 시작
테스트해 보기
"documentation" 사용 중입니다. Документировать эту функцию, которая получает данные пользователя
예상 결과:
- Краткое описание того, что делает функция
- @param userId - The unique identifier for the user
- @returns Promise resolving to user data object
- @example const user = fetchUserById('123');
"documentation" 사용 중입니다. Создать Storybook историю для компонента Button
예상 결과:
- Meta конфигурация с заголовком 'Components/Button'
- История по умолчанию без аргументов
- Вариант загрузки с пропом isLoading: true
- Вариант отключения с пропом isDisabled: true
보안 감사
안전Pure documentation template skill with no executable code. All 53 static findings are false positives: SHA-256 hashes were misidentified as weak crypto, markdown code fences were misidentified as shell execution, and metadata fields were misidentified as security risks. The skill only contains documentation templates for TSDoc, Storybook, VitePress, and TypeDoc.
위험 요인
⚡ 스크립트 포함
🌐 네트워크 접근
📁 파일 시스템 액세스
🔑 환경 변수
⚙️ 외부 명령어
품질 점수
만들 수 있는 것
Документирование экспортируемых функций
Добавление TSDoc комментариев к функциям с параметрами, типами возвращаемых значений и примерами
Создание историй компонентов
Написание Storybook историй для React компонентов с аргументами и вариантами
Создание справочной документации API
Генерация TypeDoc API документации из TSDoc комментариев
이 프롬프트를 사용해 보세요
Add TSDoc comments to this function with @param, @returns, and @example tags.
Create a Storybook story for this React component with default, loading, and error states.
Add TSDoc documentation to this custom hook including options, return values, and usage example.
Generate TypeDoc API documentation and update the VitePress sidebar for this component.
모범 사례
- Включайте теги @example с выполняемыми фрагментами кода
- Документируйте все экспортируемые функции и типы
- Используйте единообразный формат TSDoc во всей вашей кодовой базе
- Запускайте 'pnpm docs:api' после добавления TSDoc комментариев
피하기
- Пропуск тегов @param или @returns для сложных функций
- Написание расплывчатых описаний без контекста
- Забывание обновлять Storybook при изменении пропов компонента
- Не запускать TypeDoc для регенерации API документации